get_option

The get_option v4 API method gets the value of a settable option.

Declaration

short get_option(
a_v4_extfn_proc_context * cntxt,
char *option_name,
an_extfn_value *output
)

Parameters

Parameter Description
cntxt The procedure context object
option_name Name of the option to get
output
  • an_extfn_value.data – UDF supplied output data pointer
  • an_extfn_value.piece_len – maximum length of output data
  • an_extfn_value.total_len – server set length of converted output
  • an_extfn_value.type – server set data type of value

Returns

1 if successful, 0 otherwise.