LEADFILECOMMENT

Summary

The LEADFILECOMMENT structure contains information about a file comment field. A pointer to an array of this structure is obtained by the LFile::ReadComments function.

Syntax

typedef struct _LEADFILECOMMENT 
{ 
   L_UINT uType; 
   L_UINT uDataSize; 
   L_SIZE_T uDataOffset; 
} LEADFILECOMMENT, *pLEADFILECOMMENT;

Members

uType

The type of this item comment. Valid values are:

Value Meaning
JPEG and LEAD File Comments
Tiff File Comments
Exif File Comments
Gif File Comments
Dicom File Comments
FlashPix File Comments
CMNT_LAST Last defined number for comments. To clear all fields, you can use the type constant as a loop counter. The first constant is 0 and the last is CMNT_LAST.

uDataSize

The number of bytes in the data items.

uDataOffset

Byte offset into the ppData variables where the data for this item starts. To read the data for this item, you can use pItemData = (ppData + uDataOffset)

Comments

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

Pass an address to pLEADFILECOMMENT to LFile::ReadComments to read all the comment fields stored in an image file. These functions will allocate this pointer with an array of pLEADFILECOMMENT structures, one for each item found. When you are done using the pLEADFILECOMMENT pointer, you must pass it to the LFile::FreeComments function to free the allocated memory.

Usage

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
Introduction
Version History
Getting Started
LEADTOOLS Raster Imaging Features
Redistributables/Files To Be Included With Your Application
Quick Reference
Classes and Member Functions
Summary of Features
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.