KVXConfigInfo

This structure defines an XML document type and the element extraction settings for that type. You can apply the settings based on the file format ID, or the root element of the file. This structure is in kvtypes.h.

typedef struct TAG_KVXConfigInfo
{
    ENdocFmt    eKVFormat;
    char*       pszRoot;
    char*       pszInMeta;
    char*       pszExMeta;
    char*       pszInContent;
    char*       pszExContent;
    char*       pszInAttribute;
}
KVXConfigInfo;

Member Descriptions

eKVFormat

The format ID as detected by file format detection. This determines the file type to which these extraction settings apply. The format ID is defined by the enumerated type ENdocFmt. See Obtain Format Information for more information on format ID values.

If you add configuration settings for a custom XML document type, you must set eKVFormat to Unknown_Fmt.

pszRoot

The root element of the file. If eKVFormat is set to Unknown_Fmt, the root element is used to determine the file type to which these settings apply. Otherwise, pszRoot is ignored.

pszInMeta

The elements extracted from the file as metadata. All other elements are extracted as text. Separate multiple entries with commas.

pszExMeta

The child elements in the included metadata elements that are not extracted from the file as metadata. For example, the default extraction settings for the Visio XML format extract the DocumentProperties element as metadata. This element includes child elements such as Title, Subject, Author, Description, and so on. However, the child element PreviewPicture is defined in pszExMeta because it is binary data and should not be extracted.

You cannot exclude any metadata elements from the output for StarOffice files. All metadata is extracted regardless of this setting.

pszInContent

The elements extracted from the file as content text.

pszExContent

The child elements in the included content elements that are not extracted from the file as content text.

pszInAttribute

The attribute values extracted from the file. If attributes are not defined, attribute values are not extracted. You must define the namespace (if used), element name, and attribute name in the following format:

namespace:elementname@attributename

For example:

microfocus:division@name

NOTE: For more information about how to specify elements, see Syntax for Specifying Elements.