OC Set cursor option

4D - Documentation   Français   English   German   4D ODBC, Command Theme List   4D ODBC, Command Alphabetical List   Back   Previous   Next

version 1.5


OC Set cursor option (login_ID; option_ID; option_Value) Longint

ParameterTypeDescription
login_IDLongintLogin ID
option_IDIntegerReference number for function
option_ValueStringValue to set the option
Function resultLongint1= The operation succeeds
0 = An error occurs
- 1 = option_ID is out of range

Description

The OC Set cursor option function allows your application to set configuration information regarding a cursor.

cursor_ID must be the ID of a previously created cursor.

option_ID is the reference number for the requested option. A list of reference numbers follows the description of this routine.

option_Value is the value to which the option will be set.

The reference numbers for option_ID are as follows:

DescriptorID
SQL_QUERY_TIMEOUT0
SQL_MAX_ROWS1
SQL_NOSCAN2
SQL_MAX_LENGTH3
SQL_ASYNC_ENABLE4
SQL_BIND_TYPE5
SQL_CURSOR_TYPE6
SQL_CONCURRENCY7
SQL_KEYSET_SIZE8
SQL_ROWSET_SIZE9
SQL_SIMULATE_CURSOR10
SQL_RETRIEVE_DATA11
SQL_USE_BOOKMARKS12
SQL_GET_BOOKMARKS13
SQL_ROW_NUMBER14

OC Set cursor option returns 1 if the operation succeeds, 0 if it fails, and -1 if option_ID is out of range.

Example

The following procedure sets the SQL_AUTOCOMMIT option (ID = 102) to manual (value = 0) and return the results in the $result variable.

   $result:=OC Set cursor option(login;102;"0")

See Also

OC Get cursor option.


4D - Documentation   Français   English   German   4D ODBC, Command Theme List   4D ODBC, Command Alphabetical List   Back   Previous   Next