ADDMESGINFO

typedef struct _ADDMESGINFO 
{ 
   L_UINT uStructSize; 
   L_TCHAR *pStrMsg; 
   L_TCHAR *pPassword; 
   L_TCHAR *pFileName; 
   L_TCHAR *pDirectory; 
   LPPOINT pStart; 
} ADDMESGINFO, *pADDMESGINFO; 

The ADDMESGINFO structure contains information about the message being added to or extracted from the bitmap and is used by the L_ExtractMessageFromBitmap and L_AddMessageToBitmap functions.

Member

Description

uStructSize

Size of this structure, in bytes. Use the sizeof operator to calculate this value.

pStrMsg

Pointer to text that will be added to or extracted from an image. When adding a message to a bitmap this pointer refers to the text message that will be added. If you want to add a file, set this pointer to NULL. When extracting a message from a bitmap there is no need to allocate this pointer, the extract function will allocate it if the embedded message is text, otherwise it remains NULL.

pPassword

Pointer to the password that will be used when adding the message to or extracting the message from the bitmap. To use the default password set this parameter to NULL. The default password is, "LEAD Technologies".

pFileName

Pointer to the name of the file that will be added to or extracted from an image. When adding a message to a bitmap this pointer refers to the name of the file that will be added, and the pStrMsg member must be set to NULL, otherwise this parameter has no effect. When extracting a message from a bitmap there is no need to allocate this pointer, the extract function will allocate it if the embedded message is a file otherwise it remains NULL.

pDirectory

Pointer to the full path name of the directory in which to save the extracted file. This parameter is used only by the L_ExtractMessageFromBitmap function. If the extracted message is a file this parameter is used to specify the path for saving the extracted file. To save the extracted file using the original path, set this parameter to NULL. If the extracted message is text this parameter has no effect.

pStart

Pointer to a structure that contains the point at which the message will be added to or extracted from the image. To use the default position set this parameter to NULL.

Comments

pADDMESGINFO is a pointer to a ADDMESGINFO structure. Where the function parameter type is pADDMESGINFO, you can declare a ADDMESGINFO variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pADDMESGINFO variable is necessary only if your program requires a pointer.

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help