RSC/MP Programming Manual

API Function Descriptions RscGetOption [RSCOG]
RscGetOption [RSCOG]
The RscGetOption function retrieves a value from an options structure. The user of this
function selects the option by placing the desired option selector in the buffer pointed
to by the pvOptionSelector parameter. See Appendix D, API Option Definitions, for a
list of options and their meanings.
USHORT RscGetOption
(ULONG ulOptionsHandle /* in */
,CHAR *pcOptionSelector /* in */
,VOID *pvOptionValue /* out */
);
ulOptionsHandle
The handle of an existing options handle created through the RscCreateOptions
function call. Placing the RSC_DEFAULT_OPTIONS constant in this field indicates
that the default options structure should be used.
pcOptionSelector
The pointer to the buffer holding the options selector text. This parameter should
point to a character string no longer than 32 bytes (including the NULL terminator
or blank padding).
pvOptionValue
The pointer to the variable used to receive the option va lue. The variable type must
match the type of the selected option.
Return Value
The return va lue is zero if the function is successful; otherwise, the function returns
one of these result va lues:
RSC_INI_FILE_NOT_FOUND
5
RSC_INVALID_OPTIONS_HANDLE
10
RSC_INVALID_OPTION_SELECTOR
11
RSC_PC_HEAP_EXHAUSTED
22
RSC_OPTIONS_AREA_CORRUPTED
34
HP NonStop Remote Server Call (RSC/MP) Programming Manual — 522360-006
10 - 16