AdomdDataReader.GetChars Method

Artykuł
12/03/2008

Returns an array of Char objects that contain a stream of values from the specified column.

Namespace: Microsoft.AnalysisServices.AdomdClient
Assembly: Microsoft.AnalysisServices.AdomdClient (in microsoft.analysisservices.adomdclient.dll)

Syntax

'Declaration
Public Function GetChars ( _
    ordinal As Integer, _
    dataIndex As Long, _
    buffer As Char(), _
    bufferIndex As Integer, _
    length As Integer _
) As Long

public long GetChars (
    int ordinal,
    long dataIndex,
    char[] buffer,
    int bufferIndex,
    int length
)

public:
virtual long long GetChars (
    int ordinal, 
    long long dataIndex, 
    array<wchar_t>^ buffer, 
    int bufferIndex, 
    int length
) sealed

public final long GetChars (
    int ordinal, 
    long dataIndex, 
    char[] buffer, 
    int bufferIndex, 
    int length
)

public final function GetChars (
    ordinal : int, 
    dataIndex : long, 
    buffer : char[], 
    bufferIndex : int, 
    length : int
) : long

Parameters

ordinal
The zero-based ordinal position of the column to be retrieved.

dataIndex
The zero-based index within the column from which to begin reading data.

buffer
The buffer into which to read the stream of characters.

bufferIndex
The zero-based index within the buffer from which to begin writing data.

length
The number of characters to read from the column.

Return Value

A Long that contains the number of characters actually read from the column.

Exceptions

Exception type	Condition
System.IndexOutOfRangeException	The value ofdataIndex is greater than Int32.MaxValue. The value of bufferIndex is less than 0 or greater than the total of length and the length of buffer.

System.IndexOutOfRangeException

The value ofdataIndex is greater than Int32.MaxValue.

The value of bufferIndex is less than 0 or greater than the total of length and the length of buffer.

Remarks

The GetChars method returns the number of available characters in the field. In most cases this is the exact length of the field. However, the number returned may be less than the true length of the field if GetChars has already been used to obtain characters from the field.

If you pass a null reference (Nothing in Visual Basic) in the buffer parameter, GetBytes returns the length of the column in characters.

No conversions are performed; therefore the data retrieved must already be a character array.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms