KeyView 23.4

# KVMetadataElem

DEPRECATED: The `KVMetadataElem` structure is deprecated in KeyView 23.2.0 and later. OpenText recommends that you access metadata using the metadata API described in Use the Metadata API.

This structure is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.

This structure contains metadata field values extracted from a mail file. This structure is defined in `kvtypes.h`.

    typedef struct tag_KVMetadataElem
    {
        int              isDataValid;
        int              dataID;
        KVMetadataType   dataType;
        char*            strType;
        void*            data;
        int              dataSize;
    }
    KVMetadataElem;

## Member Descriptions

`isDataValid` | Specifies whether the metadata returned from the API is valid data.
`dataID` | The integer name of the extracted metadata field.
`dataType` | The data type of the metadata field. The types are defined in KVMetadataType in `kvtypes.h`.
`strType` | A pointer to the string name of the metadata field.
`data` | The contents of the metadata field. If the `type` member is `KVMetadata_Int4` or `KVMetadata_Bool`, this member contains the actual value. Otherwise, this member is a pointer to the actual value. `KVMetadata_DateTime` points to an 8-byte value. `KVMetadata_String` and `KVMetadata_Unicode` point to the beginning of the string that contains the text. The strings are `NULL` terminated. `KVMetadata_Binary` points to the first element of a byte array.
`dataSize` | The byte count of data when the type is `KVMetadata_Binary`, `KVMetadata_Unicode`, or `KVMetadata_String`.

Copyright 2016-2023 Open Text
Version 23.4 | Last updated September 2023

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL KeyView 23.4

Topic Title: KVMetadataElem