DB2®Command.ResultSetAsReturnValue Property

Set this value to retrieve result sets from Informix® user-defined routines (UDR) as a ReturnValue parameter. This property is ignored when a ReturnValue parameter is not bound in the parameter collection.

Namespace:
IBM.Data.DB2
Assembly:
IBM.Data.DB2 (in IBM.Data.DB2.dll)

Syntax


[Visual Basic]
Public Property ReturnSetAsReturnValue As Boolean
[C#]
public bool ReturnSetAsReturnValue {get; set;}
[C++]
public: __property bool get_ReturnSetAsReturnValue();
public: __property void set_ReturnSetAsReturnValue(bool);
[JScript]
public function get ReturnSetAsReturnValue() : Boolean;
public function set ReturnSetAsReturnValue(Boolean);

Property value

Set to true to work with Informix UDRs that return result sets. Otherwise, set to false. The default value is false.

Exceptions

Exception type Condition
InvalidCastException The specified cast is not valid.
DB2Exception Invalid conversion.

Remarks

If this property is set, and the UDR returns multiple rows or columns, the ReturnValue parameter contains the value of the first row and first column. Other values are ignored and are inaccessible.

This property does not affect DB2CommandBuilder.DeriveParameters(). Applications should specify the correct type for the ReturnValue parameter. If the type does not match the ReturnValue parameter, an exception is generated.

Data server restrictions

All data servers other than IBM® Informix
this property is supported only on IBM Informix.