2.2.3.13.3 rdsExecuteOptions

  • Article

The rdsExecuteOptions specifies a bitmask that selects behavior options for processing an rdsExecuteRequest.<34>

The syntax of an rdsExecuteOptions is as follows.

 rdsExecuteOptions = VT-I4 LONG;
            
 rdsExecuteReadOnly             = %x01.00.00.00
 rdsExecuteNoBatch              = %x02.00.00.00
 rdsExecuteAllParamInfoSupplied = %x04.00.00.00
 rdsExecuteGetInfo              = %x08.00.00.00
 rdsExecuteGetHiddenColumns     = %x10.00.00.00

The options are described in the following table.<35>

 Bit flag value

 Description

%x01.00.00.00

ReadOnly - The RecordSet will be opened in read-only mode such that the data cannot be altered.

%x02.00.00.00

NoBatch - The RecordSet will be opened in optimistic locking mode, record by record. This means that the server uses optimistic locking.

%x04.00.00.00

AllParamInfoSupplied - The caller guarantees that parameter information for all parameters is supplied in pParameters.

%x08.00.00.00

GetInfo - Parameter information for the query will be obtained from the server and returned in the rdsSQLCommandParameters parameter. The query is not executed and no RecordSet is returned.

%x10.00.00.00

GetHiddenColumns - The RecordSet will be opened in optimistic locking mode and any hidden columns will be included in the RecordSet.

If multiple options are set, GetHiddenColumns take precedence over all others followed by ReadOnly. If no options are specified, the server SHOULD behave as if only NoBatch is set in rdsExecuteOptions.