Search:

XC_FIELD_DESC

As defined in xctypes.h

typedef struct XC_FIELD_DESC
{
    xuint64 xfd_id; // [INPUT] XCAPI Field or Field Group ID
    xuint64 xfd_buffer_address; // [INPUT] Address of output buffer for this field/group
    xuint32 xfd_elmsiz; // [INPUT] Size of each element to be written (if count > 1)
    xuint32 xfd_in_count; // [INPUT] Maximum number of elements to retrieve (must be 1 for non-array fields/groups)
    xuint32 xfd_out_count; // [OUTPUT] Number of elements written to output buffer
    xuint32 xfd_status; // [OUTPUT] Status of individual field/group retrieval
    xuint8 xfd_desc_size; // [INPUT] Size of XC_FIELD_DESC (in bytes)
    xuint8 XFD_RESERVED_00;
    xuint16 XFD_RESERVED_01;
    union
    {
        xuint32 RESERVED_02[3]; // placeholder for variable part of structure
        struct
        {
            XM_DATA_TYPE xfds_string_type; // [INPUT] Convert output to specified string type
            xuint16 xfds_field_width; // [INPUT] Field width if convert_to_type is XTYP_STRING_xxx
            xuint32 xfds_options; // [INPUT] Conversion options appropriate to data type (see xcvttyp.h)
        } ;
        struct
        {
            XM_DATA_TYPE xfdb_convert_type; // [INPUT] Convert output to specified binary type
        } ;
    } ;
} XC_FIELD_DESC;

Description: The data structure used with xcGetFieldSet to retrieve a set of fields and/or field groups in a single call. Please see xcGetFieldSet() and xcAttachFieldSet() for more detailed information on XC_FIELD_DESC, including macros for constructing the struct and details on available formatting options.



[ Top Of Page ]