ID_GetMetadataList function

Function to retrieve some or all of the metadata in an image.

Syntax

PLUGIN_API int __stdcall ID_GetMetadataList
(
   ID_StateHdl hs,
   int iPage,
   int nMetaTypes,
   GUID* guidTypes,
   MD_MetadataList* pList
);

Parameters

hs

Type: ID_StateHdl

[in] Image state handle; hs is set by the host application to the same value that was passed to it by the plug-in during the relevant call to ID_OpenImage.

iPage

Type: int

[in] page to retrieve metadata from

nMetadataTypes

Type: int

[in] number of metadata types that guidTypes contains

guidTypes

Type: GUID*

[in] array of GUID's corresponding to types of metadata, of length nMetadataTypes

pList

Type: MD_MetadataList*

[i/o] A list of MD_MetadataItem's that the plug-in should add metadata to. (See Metadata.h for more details.) The host initializes the list. The plug-in initalizes the items, and then adds them to the list.

Return Value

For a description of return values, see Return Values.

Remarks

When nMetadataTypes is set to 0 and guidTypes is set to NULL, you must return all metadata from the image.

Requirements

Header: ID_PlugIn.h

See also: