Guardian C Library Calls Reference Manual

get_param_msg (supplementary)
3-78 128833—Guardian TNS C Library Calls Reference Manual
Reference to Library Calls
get_param_msg (supplementary)
The get_param_msg function retrieves the param message.
param_msg
points to a structure of type param_msg_type that is declared in the header stdlibh.
See “Usage Guidelines” for more details regarding this type. The get_param_msg
function copies the param message into the structure pointed to by this param_msg
parameter.
actual_len
points to the short integer where get_param_msg copies the actual length of the
param message.
Return Value
is 0 if the param message is found, and -1 if the param message is not found.
Usage Guidelines
•
The type param_msg_type is declared in the header stdlibh as:
typedef struct
{
short msg_code;
short num_params;
char parameters[1024];
} param_msg_type;
•
In the type param_msg_type, the structure members provide the following
information:
#include <stdlibh>
short get_param_msg(param_msg_type *param_msg,
short *actual_len);
msg_code
value of -3 for a param message
num_params
number of parameters in the message
parameters[1024]
the parameters with each parameter having this structure:
param[0] =
“n”, length in bytes of
parameter name
param[1] FOR n =
parameter name
param[n+1] =
“v”, length in bytes of
parameter value
param[n+2] FOR v =
parameter value