GetOption()


" "

short GetOption(short Option, VARIANT* Value)

Description

Gets the specified option value in QMF for Windows.

Parameters

Name Description
Options Specifies what option to retrieve.


The following options are available for retrieval:


0 (RSO_SERVER_DEFINITION_FILE) Server definition file name
1 (RSO_CPIC_DLL) CPI-C Provider DLL file name
2 (RSO_CPIC_TIMEOUT_WARNING) CPI-C warning timeout (in seconds). This limit is not used for the QMF for Windows API.
3 (RSO_CPIC_TIMEOUT_CANCEL) CPI-C cancel timeout (in seconds)
4 (RSO_TCP_TIMEOUT_WARNING) TCP warning timeout (in seconds). This limit is not used for the QMF for Windows API.
5 (RSO_TCP_TIMEOUT_CANCEL) TCP cancel timeout (in seconds).
6 (RSO_DISPLAY_NULLS_STRING) The string to use to display null values.
7 (RSO_ENTER_NULLS_STRING) The string to use to enter null values.
8 (RSO_ENTER_DEFAULTS_STRING) The string to use to enter default values.
9 (RSO_TRACE_FILE_1) Trace file 1 name.
11 (RSO_TCP_TRACE_LEVEL) TCP trace level.
12 (RSO_CPIC_TRACE_LEVEL) CPI-C trace level.
13 (RSO_DDM_TRACE_LEVEL) DDM trace level.
14 (RSO_CLI_TIMEOUT_WARNING) CLI warning timeout (in seconds). This limit is not used for the QMF for Windows API.
15 (RSO_CLI_TIMEOUT_CANCEL) CLI cancel timeout (in seconds).
16 (RSO_CLI_TRACE_LEVEL) CLI trace level.
17 (RSO_SQLAM__TRACE_LEVEL) SQLAM trace level.
18 (RSO_EMBEDDEDSQL_TRACE_LEVEL) Embedded SQL trace level.
19 (RSO_REXX_TRACE_LEVEL) REXX trace level.
20 (RSO_LOB_OPTION_OVERRIDE) Allow override of retrieve LOB option.
21 (RSO_RETRIEVE_LOB_OPTION) Retrieve LOB option.
22 (RSO_MAX_LOB_COLUMN_SIZE) Maximum LOB column's size in kilobytes.
23 (RSO_ODBC_TIMEOUT_WARNING) ODBC warning timeout (in seconds)
24 (RSO_ODBC_TIMEOUT_CANCEL) ODBC cancel timeout (in seconds).
25 (RSO_ODBC_TRACE_LEVEL) ODBC trace level.
26 (RSO_MAIL_TRACE_LEVEL) Mail trace level.
27 (RSO_MESSAGES_TRACE_LEVEL) Messages trace level.
28 (RSO_DYNAMICSQL_TRACE_LEVEL) Dynamic SQL trace level.
29 (RSO_SAVING_LOB_OPTION) Save LOB option.
30 (RSO_RECENTLY_USED_SERVERS_FIRST) When listing the servers in the SDF, display the most recently used servers first.
31 (RSO_ENABLE_EXT_FOR_SPATIAL_DATA) Enable the use of spatial data (.shp files).
32 (RSO_DATA_ORIENTATION) Specifies the data orientation of query results and reports.
33 (RSO_ENABLE_COLORING_TEXT) Enable the use of colored text.
34 (RSO_DE_FAVORITES) Include a branch for favorites in the Database Explorer tree.
35 (RSO_RECENTLY_USED_SERVERS) Include a branch for recently used servers in the Database Explorer tree.
36 (RSO_DE_RECENTLY_USED_OBJECTS) Include a branch for recently used objects in the Database Explorer tree.
37 (RSO_DE_ALL_SERVERS) Include a branch that will include all servers in the Database Explorer tree.
38 (RSO_RECENT_LIST_FOR_SERVERS) Number of servers that will be listed in the Recently Used Servers branch of the Database Explorer tree.
39 (RSO_RECENT_LIST_FOR_OBJECTS) Number of objects that will be listed in the Recently Used Objects branch of the Database Explorer tree.
40 (RSO_DEF_DOUBLE_CLICK_ACTION) Result action of a double-click on an object in the Database Explorer tree.
41 (RSO_ENABLE_WEB_UPDATES) Periodically check the web site for QMF for Windows application updates.
42 (RSO_CHECK_FOR_UPDATES) Specify how frequently QMF for Windows will check the web site for application updates.
43 (RSO_DISP_ERROR_MESSAGE) Display error messages that occur while checking the web site for product updates.


Value

A pointer to a VARIANT in which the result is stored. Initialize the VARIANT before calling this function. Visual Basic does this automatically. Visual C++ programmers should call VariantInit().

Note:
Due to a bug in Microsoft Excel 7.0 and Microsoft Access 7.0 (and possibly other 32-bit Microsoft products that use Visual Basic for Applications), string data in Variant variables received from QMF for Windows may not be translated from Unicode (used by OLE) to ANSI (used by VBA). When this occurs, only the first character of the string is displayed. To remedy this problem, set the variable equal to an empty string before you call the QMF for Windows function that uses the variable.

Return Value

The return value will be zero, if successful and non-zero if unsuccessful. If the return value is non-zero, you can call GetLastErrorString(), GetLastErrorType(), to get additional error information.

Related Tasks

SetOption()