Global Library Functions 

PxIOGetLibOption

 

Description

Obtains the current setting of a global library option

Format

int PxIOGetLibOption(PxIOService service, PxIOLibOptionType type, int *value);

Where:

service

A valid PxIOService handle. See PxIOCreateService for more information on creating a service and obtaining a service handle. This option is necessary to ensure that the calling process is a legitimate client of the library.

type

Library option value to retrieve. The available options are listed in Appendix A.

value

A pointer to an int variable to be used to save the option value

Return Value

If the function succeeds, a value of PXIO_SUCCESS_STATUS is returned; otherwise, an error value is returned. More information on the nature of the error can be found by calling PxIOGetError.