LAnnotation::GetPredefinedMetafile

Show in webframe

#include "ltwrappr.h"

static L_INT LAnnotation::GetPredefinedMetafile(uType, phMetafile, pbEnhanced)

L_UINT uType;	/* constant that indicates the metafile to retrieve */
HMETAFILE * phMetafile;	/* pointer to a variable to be updated with the handle to the metafile */
L_BOOL * pbEnhanced;	/* flag that indicates whether the retrieved metafile is enhanced */

Retrieves a copy of the specified predefined metafile.

Parameter	Description
uType	Constant that indicates the metafile to retrieve. Possible values are:

	Value			Meaning
	ANNMETAFILE_APPROVED			[0] predefined metafile - APPROVED
	ANNMETAFILE_ASSIGNED			[1] predefined metafile - ASSIGNED
	ANNMETAFILE_CHECKED			[2] predefined metafile -CHECKED
	ANNMETAFILE_CLATPRV			[3] predefined metafile - CLIENT ATTORNEY PRIVILEGE
	ANNMETAFILE_COPY			[4] predefined metafile - COPY
	ANNMETAFILE_DRAFT			[5] predefined metafile - DRAFT
	ANNMETAFILE_EXTENDED			[6] predefined metafile - EXTENDED
	ANNMETAFILE_FAX			[7] predefined metafile - FAX
	ANNMETAFILE_FAXED			[8] predefined metafile - FAXED
	ANNMETAFILE_IMPORTANT			[9] predefined metafile - IMPORTANT
	ANNMETAFILE_INVOICE			[10] predefined metafile - INVOICE
	ANNMETAFILE_NOTICE			[11] predefined metafile - NOTICE
	ANNMETAFILE_OFFICIAL			[12] predefined metafile - OFFICIAL
	ANNMETAFILE_ONFILE			[13] predefined metafile - ON FILE
	ANNMETAFILE_PAID			[14] predefined metafile - PAID
	ANNMETAFILE_PASSED			[15] predefined metafile - PASSED
	ANNMETAFILE_PENDING			[16] predefined metafile - PENDING
	ANNMETAFILE_PROCESSED			[17] predefined metafile - PROCESSED
	ANNMETAFILE_RECEIVED			[18] predefined metafile - RECEIVED
	ANNMETAFILE_REJECTED			[19] predefined metafile - REJECTED
	ANNMETAFILE_RELEASE			[20] predefined metafile - RELEASE
	ANNMETAFILE_SENT			[21] predefined metafile - SENT
	ANNMETAFILE_SHIPPED			[22] predefined metafile - SHIPPED
	ANNMETAFILE_TOPSECRET			[23] predefined metafile - TOP SECRET
	ANNMETAFILE_URGENT			[24] predefined metafile - URGENT
	ANNMETAFILE_VOID			[25] predefined metafile - VOID
	ANNMETAFILE_HOTSPOT			[26] predefined metafile for hotspots and freehand hotspots.
	ANNMETAFILE_ENCRYPTOR			[27] predefined metafile for an encrypt object in the encryptor state
	ANNMETAFILE_DECRYPTOR			[28] predefined metafile for an encrypt object in the decryptorstate
phMetafile		Pointer to a variable to be updated with the handle to the specified metafile.
pbEnhanced		Flag that indicates whether the retrieved metafile is enhanced or not. Possible values are:
		Value	Meaning
		TRUE	The retrieved metafile is an enhanced metafile.
		FALSE	The retrieved metafile is a windows metafile.

Returns

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

Comments

You must free the metafile handle when you are finished, using either DeleteMetaFile or DeleteEnhMetaFile.

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.

See Also

Functions:	LAnnotation::SetPredefinedMetafile, LAnnFreehandHotSpot::GetMetafile, LAnnFreehandHotSpot::SetMetafile, LAnnHotSpot::GetMetafile, LAnnHotSpot::SetMetafile, LBitmap::Scramble, LAnnEncrypt::GetEncryptOptions, LAnnEncrypt::SetEncryptOptions, LAnnContainer::EncryptApply, LAnnEncrypt::GetSecondaryMetafile, LAnnStamp::GetSecondaryMetafile, LAnnEncrypt::GetSecondaryMetafile, LAnnPoint::GetPredefinedBitmap, LAnnPoint::SetPredefinedBitmap, LAnnAutomation::GetPointOptions, LAnnPoint::GetPointOptions
Topics:	Annotation Functions: Object Properties
	Annotation Objects - Default Values
	Annotation Objects - Automated Features
	Using Annotation Bitmap Objects

Example

L_INT LAnnotation_GetPredefinedMetafileExample()
{
   L_INT nRet;
   HMETAFILE hMetafile;
   L_BOOL bEnhanced;
   nRet = LAnnotation::GetPredefinedMetafile(ANNMETAFILE_IMPORTANT, &hMetafile, &bEnhanced);
   return nRet;
   //... Do something with hMetafile
}