This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %Library.JGWResultSet extends %Library.IResultSet, %Library.IProcedureContext

Property Inventory (Including Private)

Method Inventory (Including Private)


property Data [ MultiDimensional ];
Property methods: DataDisplayToLogical(), DataGet(), DataIsValid(), DataLogicalToDisplay(), DataLogicalToOdbc(), DataNormalize(), DataSet()
property colindex [ MultiDimensional ];
Property methods: colindexDisplayToLogical(), colindexGet(), colindexIsValid(), colindexLogicalToDisplay(), colindexLogicalToOdbc(), colindexNormalize(), colindexSet()
property columns [ MultiDimensional ];
Property methods: columnsDisplayToLogical(), columnsGet(), columnsIsValid(), columnsLogicalToDisplay(), columnsLogicalToOdbc(), columnsNormalize(), columnsSet()
property firsttime as %Integer;
Property methods: firsttimeDisplayToLogical(), firsttimeGet(), firsttimeIsValid(), firsttimeLogicalToDisplay(), firsttimeNormalize(), firsttimeSet()
property gwc as %SQLGatewayConnection;
Property methods: gwcGet(), gwcGetSwizzled(), gwcIsValid(), gwcNewObject(), gwcSet()
property hstmt as %String;
Property methods: hstmtDisplayToLogical(), hstmtGet(), hstmtIsValid(), hstmtLogicalToDisplay(), hstmtLogicalToOdbc(), hstmtNormalize(), hstmtSet()
property sentODBC as %Integer;
Property methods: sentODBCDisplayToLogical(), sentODBCGet(), sentODBCIsValid(), sentODBCLogicalToDisplay(), sentODBCNormalize(), sentODBCSet()


method %CloseCursor() as %Status
Inherited description: This method is expected to be overridden by concrete subclasses
method %Get(colname As %String = "") as %Library.String
Inherited description: Returns the value of the column with the name pColumnName in the current row of the result set.

If pColumnName is not a valid column name, this method returns an empty string.

method %GetData(colnbr As %Integer) as %Library.String
Inherited description: Returns the value of column pColumnNumber in the current row of the result set.
method %Next(ByRef sc As %Library.Status = $$$OK) as %Library.Integer
Inherited description: Advance the procedural result set cursor to the next row. Returns 0 if the cursor is at the end of the result set or if an error was encountered. Errors are reported in dynamic SQL using the %SQLCODE and %Message properties of the statement result. An optional argument will contain a %Status value on return. This %Status value indicates success or failure of the %Next call but it should be considered to be a secondary error reporting interface, %SQLCODE being the primary error reporting mechanism. This implementation can be overridden by classes that implement the procedural cursor interface.
private method %OnClose() as %Status
This callback method is invoked by the %Close() method to provide notification that the current object is being closed.

The return value of this method is ignored.

private method %OnNew(conninfo As %CacheString) as %Status
it expects $lb(dllHandle,ConnectionHandle,StatementHandle)
method %Print(pDelimiter As %Library.String = " ") as %Status
Inherited description: Print the contents of the current row on the current device.
method %SendODBC() as %Integer
Inherited description: Fetch and send a series of rows for the ODBC/JDBC server. For internal use only.
method CreateStaticRS(ByRef sqcon As %Library.ObjectHandle) as %Library.Status
private method InitMetadata() as %Status
This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created. it expects $lb(dllHandle,ConnectionHandle,StatementHandle)

method NextResult() as %Library.RegisteredObject
Inherited description: Called to return the next resultset object. This also removes the reference to the existing object so it can cleanup and close itself

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)