Guardian Native C Library Calls Reference Manual (G06.28+, H06.05+)

get_param_msg(3) Guardian Native C Library Calls Reference Manual
NAME
get_param_msg - Retrieves the param message
LIBRARY
G-series native Guardian processes: $SYSTEM.SYSnn.ZCRTLSRL
G-series native OSS processes: /G/system/sysnn/zcrtlsrl
H-series native Guardian processes: $SYSTEM.ZDLLnnn.ZCRTLDLL
H-series OSS processes: /G/system/zdllnnn/zcrtldll
SYNOPSIS
#include <stdlib.h>
short get_param_msg(
param_msg_type *param_msg,
short *actual_len);
PARAMETERS
param_msg Points to a structure of type param_msg_type where the retrieved param mes-
sage is copied. param_msg_type is declared in the header stdlib.h.
actual_len Points to the short integer where get_param_msg() copies the actual length of
the param message.
DESCRIPTION
The get_param_msg() function retrieves the param message.
The get_param_msg() function can be called in Guardian modules (modules compiled for the
Guardian environment) within Guardian processes only.
The type param_msg_type is declared in the header stdlib.h 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:
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.
RETURN VALUES
If the param message is found, the value 0 (zero) is returned. If the param message is not found,
-1 is returned.
3−28 Hewlett-Packard Company 527192-007