Start of change

Cloud Data Access callable services

All APIs accept a pointer to an optional parameter structure that describe a group of key:value pairs that can be used to modify the processing done by the particular API. The specific keys that are recognized varies per API and are described with each API. The APIs accept a pointer to the GDK_OPTIONAL_PARMS_TYPE structure, or NULL if none are desired. GDK_OPTION_KEY_TYPE is a pointer to character array (char *). GDK_OPTION_VALUE_TYPE is also a pointer to a character array unless the value is expected to be different.

   typedef struct {
     uint32_t GDK_NumberOfOptions;
     GDK_OPTION_TYPE GDK_OptionArray[];
   }   GDK_OPTIONAL_PARMS_TYPE;

   typedef struct { 
     GDK_OPTION_KEY_TYPE GDK_optionKey;
     GDK_OPTION_VALUE_TYPE GDK_optionValue;
   }   GDK_OPTION_TYPE;
Table 1. GDK_OPTIONAL_PARMS_TYPE
GDK_OPTIONAL_PARMS_TYPE
Offset Len Type Name Description
0   STRUCTURE GDK_OPTIONAL_PARMS_TYPE Structure of one optional parameter.
0 4 NUMBER GDK_OptionArray Array of GDK_OPTION_TYPE entries
4 * ARRAY GDK_OptionArray Array of GDK_OPTION_TYPE entries.
Table 2. GDK_OPTION_TYPE
GDK_OPTION_TYPE
Offset Len Type Name Description
0   STRUCTURE GDK_OPTION_TYPE Structure of one optional parameter.
0 4 POINTER GDK_OptionKey Pointer to Null-terminated character string for the key of the optional parameter.
4 4 POINTER GDK_optionValue Pointer to Null-terminated character string or value for the value related to the optional parameter.
End of change