Open System Services Library Calls Reference Manual (G06.29+, H06.08+, J06.03+)

get_param_by_name(3) OSS Library Calls Reference Manual
NAME
get_param_by_name - Retrieves value of a parameter by parameter name
LIBRARY
G-series native Guardian processes: $SYSTEM.SYSnn.ZCRTLSRL
G-series native OSS processes: /G/system/sysnn/zcrtlsrl
H-series and J-series native Guardian processes: $SYSTEM.ZDLLnnn.ZCRTLDLL
32-bit H-series and J-series OSS processes: /G/system/zdllnnn/zcrtldll
64-bit H-series and J-series OSS processes: /G/system/zdllnnn/ycrtldll
SYNOPSIS
#include <stdlib.h>
short get_param_by_name (
char *param_name,
char *param_value,
short max_len);
PARAMETERS
param_name Points to the NULL terminated name of the parameter.
param_value Points to the NULL terminated value assigned to the parameter name.
max_len Specifies the maximum length of the NULL terminated string that can be copied
to param_value.
DESCRIPTION
The get_param_by_name( ) function retrieves the value of the parameter that corresponds to the
parameter name requested. Parameters can be created with the TACL PARAM command.
The get_param_by_name( ) function can be called in Guardian modules (modules compiled for
the Guardian environment) within Guardian processes only.
RETURN VALUES
If the parameter name is found, the value 0 (zero) is returned. If the parameter name is not found,
-1 is returned. If the parameter name is found but the buffer provided to contain the value is too
small, -2 is returned.
RELATED INFORMATION
Functions: get_assign_msg(3), get_assign_msg_by_name(3),
get_max_assign_msg_ordinal(3), get_param_msg(3), get_startup_msg(3).
STANDARDS CONFORMANCE
The get_param_by_name( ) function is an HP extension to the XPG4 Version 2 specification.
3−100 Hewlett-Packard Company 527187-017