KVGetSubFileMetadataListArg

This structure defines the input parameters required to retrieve subfile metadata using the function fpGetSubFileMetadataList(). This structure is defined in kvxtract.h.

typedef struct tag_KVGetSubfileMetadataListArg
{
    KVStructHeader;
    int index; /*The sub file index*/
    KVCharSet srcCharset; /*The source charset of the sub file when the charset conversion
			*is applicable. It can be used to specify the source charset when
			*the SDK is unable to detect the charset of the sub file.
			*Once a valid charset is specified, the source charset will
			*overwrite the detected sub file's charset.*When the source charset is unknown (i.e. SDK is unable to detect
			*the sub file's charset and this srcCharset is not provided), the charset
			*conversion will not occur.*/
    KVCharSet trgCharset; /*The target charset of the metadata to be extracted */
    int isMSBLSB;  /*If it is unicode, this flag indicate whether the byte order is little endian*/
} KVGetSubfileNewMetadataArgRec, * KVGetSubfileNewMetadataArg;
		

Member Descriptions

KVStructHeader

The KeyView version of the structure. See KVStructHead.

index

The index number of the subfile.

srcCharset

Specifies the source character set of the metadata when the format’s reader cannot determine the character set. The character sets are enumerated in KVCharSet in kvcharset.h. See Discussion.

trgCharset

The target character set for the extracted metadata. The character sets are enumerated in KVCharSet in kvcharset.h.

isMSBLSB

Indicates whether the byte order for Unicode text is Big Endian (MSBLSB) or Little Endian (LSBMSB).

Discussion

If the character set is detected and is also specified in srcCharset, the detected character set is overridden by the specified character set. If the source character set is not detected and is not specified, character set conversion does not occur. The section Document Readers lists the formats for which the source character set can be determined.