IGR_Get_Option_Attribute¶

IGR_Get_Option_Attribute returns information about each published option value.

Prototype¶

C/C++

IGR_LONG IGR_Get_Option_Attribute(
    int option_index,
    int what,
    char* buffer,
    Error_Control_Block* error);;

option_index: Integer

0-based index of the option to fetch.

what: Integer

Indicates the information to return, can be one of:

Value	Description
0	copy the display name of the option
1	copy the English description. Localized versions are not available.
2	copy the default value
3	copy the option flags

buffer: Pointer to an Ansi string

The buffer that will be populated based on the value of ‘what’.

bufferSize: Size_t

The size of the provided buffer

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.