File Content Extraction 25.1
XML Export SDK C Programming Guide

# 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 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`. DEPRECATED: Target character encodings other than UTF-8 and UTF-16 are deprecated in File Content Extraction version 24.4. OpenText recommends that you use UTF-8 or UTF-16, in Little Endian byte order. Support for other character encodings is currently available but might be removed in a future release.
`isMSBLSB` | Indicates whether the byte order for Unicode text is Big Endian (MSBLSB) or Little Endian (LSBMSB). DEPRECATED: This option is deprecated in File Content Extraction version 24.4. OpenText recommends that you set this value to 0, which outputs UTF-16 text in Little Endian byte order. This option might be removed in a future release.

## 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.

Copyright 1997-2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: File Content Extraction 25.1

Topic Title: KVGetSubFileMetadataListArg