QPx_GetOption

QPx_GetOption(optionName; numericValue; textValue):error
optionName Text Option name
numericValue Real Numeric value
textValue Text Textual value
error Longint Error result

Retrieves internal plug-in options.

QPix has some internal settings that control various aspects of its operations. QPx_GetOption gives access to these settings.

Each internal setting or option is addressed by its name. Option names are strings that look like file system pathnames. Option names are specified by the optionName parameter.

Plug-in options have either numeric or textual values, depending on the particular option. Numeric option values are received by the numericValue parameter, and textual values by the textValue parameter.

For a list of plug-in option names with descriptions and acceptable option values, see the QPx_SetOption command.

Related commands

QPx_SetOption Modifies internal plug-in options

QPix © Escape
Generated by QDoc 2.8 on Wed, Feb 17, 2010 17:46:46