Skip to main content

%ResultSet.MetaData

Class %ResultSet.MetaData Extends %RegisteredObject [ System = 2 ]

This class has been superseded. It will remain for compatibility with existing code and samples. We recommend using %SQL.Statement.

Properties​

columnCount​

Property columnCount As %Integer;

The number of columns defined as SQLRESULTCOL that are returned by executing this statement. This is the same as columns.Count().

columns​

Property columns As list Of %ResultSet.MD.Column;

columnIndex​

Property columnIndex As %String(MAXLEN = "") [ MultiDimensional ];

parameters​

Property parameters As list Of %ResultSet.MD.Parameter;

objects​

Property objects As list Of %ResultSet.MD.ObjectId;

Methods​

%OnNew​

Method %OnNew(initvalue As %RawString = "", pParameters As %RawString = "", pObjects As %RawString = "") As %Status [ Private, ProcedureBlock = 1, ServerOnly = 1 ]

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 is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status %ResultSet.MetaData is a metadata class for result set metadata. The initial value is the metadata from a result set object or it is the result set object itself.

print​

Method print() As %Status

printMetaData​

Method printMetaData(pMetadata As %RawString) As %Status

%Display​

Method %Display() As %Status

Display metadata on the current device.

GenerateRowType​

Method GenerateRowType() As %Library.String(MAXLEN="") [ Internal, ServerOnly = 1 ]