In This Topic ▼

LAnnFreehandHotSpot::GetSecondaryMetafile

Summary

Retrieves the metafile handle associated with an FreehandHotSpot object when it is in the decryptor state.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnFreehandHotSpot::GetSecondaryMetafile(phMetafile)

Parameters

HMETAFILE * phMetafile

Pointer to a variable to be updated with the handle to a metafile.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The FreehandHotSpot object has two states:

Encryptor
Decryptor

Each state is displayed with its own metafile. Use this function to retrieve the current metafile for an FreehandHotSpot object in a decryptor state. The default image is shown in the figure below:

$image\decryptresized20.gif$

If this function is successful, the address pointed to by phMetafile will be updated with the metafile handle.

Use the LAnnFreehandHotSpot::GetMetafile function to retrieve the current metafile for an FreehandHotSpot object in an encryptor state.

Required DLLs and Libraries

LTANN
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

Example

// This example swaps the metafiles for a FreeHandHotSpot object.

L_INT LAnnFreehandHotSpot_GetSecondaryMetafileExample(LAnnFreehandHotSpot *pLFreehandHotSpot) 
{ 
   L_INT nRet; 
   HMETAFILE hMetafile1=0; 
   HMETAFILE hMetafile2=0; 
 
   nRet = pLFreehandHotSpot->GetMetafile(&hMetafile1); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = pLFreehandHotSpot->GetSecondaryMetafile(&hMetafile2); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = pLFreehandHotSpot->SetMetafile(hMetafile2, ANNMETAFILE_USER, 0); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}