L_ReadFileComments

#include "l_bitmap.h"

L_LTFIL_API L_INT L_ReadFileComments(pszFile, uFlags, puCommentCount, ppComments, puDataSize, ppData, pLoadOptions)

L_TCHAR * pszFile;

/* input file name */

L_UINT uFlags;

/* control flags */

L_UINT* puCommentCount;

/* address of the variable to be updated with the number of comments found */

pLEADFILECOMMENT * ppComments;

/* address of the variable for comment data */

L_SIZE_T* puDataSize;

/* address of the variable to be updated with the overall size of the comment data */

L_UCHAR** ppData;

/* address of the variable to be updated with the overall comment data */

pLOADFILEOPTION pLoadOptions;

/* pointer to optional extended load options */

Gets all the comment fields stored in a file.

Parameter

Description

pszFile

Character string that contains the input file name.

uFlags

Flag that determines whether to read the tag overall data. You can combine values when appropriate by using a bitwise OR ( | ):

 

Flag

Meaning

 

READFILEMETADATA_NOMEMORY

[0x01] Do not read the tag overall data. If this flag is set, then puDataSize and ppData will not be used and the function will not read the comment overall data.

puCommentCount

Address of the variable to be updated with the number of comments found in the file.

ppComments

Pointer to an array of LEADFILECOMMENT structures. Each element of the array contains data for one comment field found in the file. The number of elements in ppComments is puCommentCount. When this array is no longer needed pass it to the L_FreeFileComments function to free the allocated memory.

puDataSize

Address of the variable to be updated with the size in bytes of the overall comment field's data.

ppData

Address of the variable to be updated with a pointer to the overall comment fields data. The size of this pointer in bytes is puDataSize. Each LEADFILECOMMENT item found contains an offset to where the data for this item is stored in ppData.

pLoadOptions

Pointer to optional extended load options. Pass NULL to use the default load options.

Returns

SUCCESS

The function was successful

< 1

An error occurred. Refer to Return Codes.

Comments

You must free the data allocated with this function using the L_FreeFileComments function.

For general information about TIFF tags, refer to Implementing TIFF Comments and Tags.

Required DLLs and Libraries

LTFIL

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, Mobile.

See Also

Functions:

L_SetComment, L_GetComment, L_ReadFileComment, L_FreeFileComments

Topics:

Implementing TIFF Comments and Tags

Example

For a short example, refer to L_ReadFileTags.