LFile::FreeComments

#include "ltwrappr.h"

L_INT LFile::FreeComments(uCommentCount, pComments, uDataSize, pData)

L_UINT uCommentCount;

/* number of comments found */

pLEADFILECOMMENT pComments;

/* comment data */

L_SIZE_T uDataSize;

/* overall size of the comment data */

L_UCHAR *pData;

/* overall comment data */

Frees the data allocated by calling the LFile::ReadComments function.

Parameter

Description

uCommentCount

The number of comments found in the file.

pComments

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 pComments is uCommentCount.

uDataSize

The size in bytes of the overall comment fields data.

pData

A pointer to the overall comment fields data. The size of this pointer in bytes is uDataSize. Each LEADFILECOMMENT item found contains an offset to where the data for this item is stored in pData.

Returns

SUCCESS

The function was successful

< 0

An error occurred. Refer to Return Codes.

Comments

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

Required DLLs and Libraries

LTFIL
File format DLLs

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:

LFile::ReadComments, Class Members

Topics:

Raster Image Functions: Maintaining File Comments

 

Implementing TIFF Comments and Tags

 

Loading and Saving Images

Example

For a short example, refer to LFile::ReadTags.