LAnnotation::GetPredefinedMetafile

Summary

Retrieves a copy of the specified predefined metafile.

Syntax

#include "ltwrappr.h"

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

Parameters

L_UINT 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 decryptor state

HMETAFILE * phMetafile

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

L_BOOL * 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

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

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 
 
} 
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.