PMDF Programmer's Reference Manual
PMDF-PRM-6.0

Previous | Contents

PMDF_option_get_integer

Get the value of an integer-valued option from an option file.

VMS FORMAT

status = PMDF_option_get_integer

(opt_context, name, value)

argument information
Argument Data type Access Mechanism
opt_context context pointer read value
name descriptor read reference
value signed longword write reference

C FORMAT

status = PMDFoptionGetInteger

(opt_context, name, name_len, value)

argument information 
int PMDFoptionGetInteger (opt_context, name, name_len, 
                          value) 
         PMDF_opt *opt_context; 
         char     *name; 
         int       name_len; 
         int      *value;

ARGUMENTS

opt_context

Pointer to context information generated by a previous call to PMDF_option_read.

name

Name of the option to obtain the value of. Name may not exceed a length in bytes of SHORT_ALFA. Option names are treated as case insensitive strings.

name_len

Length in bytes of the option name.

value

Value of the specified option.

DESCRIPTION

PMDF_option_get_integer returns in value the value of the specified option. If the option was not specified in the option file or if opt_context is zero (nil), then the content of value is left unchanged.
Return Values
PMDF__OK Normal, successful completion.
PMDF__INVSTRDES Invalid string descriptor for name: descriptor has an invalid value in its DSC$B_CLASS field. No option value returned.
PMDF__STRTRUERR Supplied name string exceeds the maximum permitted length. No option value returned.

Previous | Next | Contents