CONNX Data Integration Suite 14.8.0 | Developer Guide | CONNX .NET Data Provider | CONNX .NET Data Provider Object Model | CNXDataReader
 
CNXDataReader
Namespace:
System.Data.CONNX
Description:
The CNXDataAdapter class handles the actual reading from the database and the data conversion from the native data source to .NET-managed types.
Properties:
FieldCount
Return Type:
Int
Description:
The FieldCount property returns an int value containing the number of fields in the resultset.
IsClosed
Return Type:
Bool
Description:
This IsClosed property returns a Boolean value that is true if the CNXDataReader is open.
RecordsAffected
Return Type:
Int
Description:
The RecordsAffected property returns an Int value that is the number of records affected.
Methods:
Close
Return Type:
Void
Description:
The Close method closes the CNXDataReader.
Parameters:
None
Dispose
Return Type:
Void
Description:
The Dispose method releases any resources held by the object.
Parameters:
Disposing
Type:
Bool
Description:
Specifies if managed resources should also be disposed (true).
GetBoolean
Return Type:
Bool
Description:
The GetBoolean method retrieves data from the specified field index and casts it to a Boolean value.
Parameters:
i
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetByte
Return Type:
Byte
Description:
The GetByte method retrieves data at the specified index and casts it to a byte.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetBytes
Return Type:
Long
Description:
The GetBytes method reads a number of bytes from the target field and fills the specified byte array with the data. The return value is the actual number of bytes read.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
FieldOffset
Type:
Long
Description:
Position in the field to begin reading.
Buffer
Type:
Byte[]
Description:
Destination array for the data.
BufferOffset
Type:
Int
Description:
Starting position in the buffer to begin writing.
Length
Type:
Int
Description:
Number of characters to read.
GetChar
Return Type:
Char
Description:
The GetChar method retrieves data from the specified index and casts it to a Char.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetChars
Return Type:
Long
Description:
The GetChars method reads a number of characters from the target field and fills the specified character array with the data. The return value is the actual number of characters read.
The GetChars method is not supported at this time. It is provided for interface compatibility.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
FieldOffset
Type:
Long
Description:
Position in the field to begin reading.
Buffer
Type:
Char[]
Description:
Destination array for the data.
BufferOffset
Type:
Int
Description:
Starting position in the buffer to begin writing.
Length
Type:
Int
Description:
Number of characters to read.
GetData
Return Type:
IDataReader
Description:
The GetData method is not supported at this time.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetDataTypeName
Return Type:
String
Description:
The GetDataTypeName method returns the datatype name for the requested field index.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetDateTime
Return Type:
DateTime
Description:
The GetTime method retrieves the data at the specified index and casts it to a DateTime.
Parameters:
I
Type:
Int]
Description:
Value that corresponds to the position of the requested field.
GetDecimal
Return Type:
Decimal
Description:
The GetDecimal method retrieves the data at the specified index and casts it to a Decimal.
Parameters:
I
Type:
Int
Description:
I Value that corresponds to the position of the requested field.
GetDouble
Return Type:
Double
Description:
The GetDouble method retrieves the data at the specified position and casts it to a Double.
Parameters:
I
Type:
Int
Visible:
Value that corresponds to the position of the requested field.
GetFieldType
Return Type:
Type
Description:
The GetFieldType method returns the Type for the requested field index.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetFloat
Return Type:
Float
Description:
The GetFloat method retrieves the data at the specified position and casts it to a Float.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetGuid
Return Type:
Guid
Description:
The GetGuid method retrieves the data at the specified index and casts it to a GUID value.
Parameters
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetInt16
Return Type:
Int16
Description:
The GetInt16 method retrieves the data at the specified index and casts it to an INT16 value.
Parameters
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetInt32
Return Type:
Int32
Description:
The Get32 method retrieves the data at the specified field and casts it to an Int32.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetInt64
Return Type:
Int64
Description:
The GetInt64 method retrieves the data at the specified field and casts it to an Int64.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetName
ReturnType:
String
Description:
The GetName method returns the name of the requested field index.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetOrdinal
Return Type:
Int
Description:
The GetOrdinal method returns the column position for the field with the specified name.
Parameters:
Name
Type:
String
Description:
Value that corresponds to the name for which the ordinal value will be returned.
GetSchemaTable
Return Type:
DataTable
Description:
The GetSchemaTable method requests the schema and returns the schema as a data table. This feature is not imlemented, but is provided for interface compatibility.
Parameters:
None
GetString
Return Type:
String
Description:
The GetString method retrieves the data contained in the specified field and casts it to a string.
Parameters:
I
Type:
int
Description:
Value that corresponds to the position of the requested field.
GetValue
Return Type:
Object
Description:
The GetValue method returns an object consisting of the data from the requested field.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
GetValues
Return Type:
Int
Description:
The GetValues method populates an object array with the data contained in the entire row. The return value is the number of fields populated.
Parameters:
Values
Type:
Object[]
Description:
Object array that is populated by the GetValues method.
IsDBNull
Return Type:
Bool
Description:
The IsDBNull method returns a Boolean value that is Trus if the value at the specified field is null.
Parameters:
I
Type:
Int
Description:
Value that corresponds to the position of the requested field.
NextResult
Return Type:
Bool
Description:
The NextResult method advances to the next Resultset when there is more than one resultset returned. This features is not supported and is provided for interface compatibility.
Parameters:
None
Read
Return Type:
Bool
Description:
The Read method advances the CNXDataReader to the next record in the resultset.
Parameters:
None.