DataReader.GetItemMaxLength Method

Article
10/02/2013

Retrieves the maximum length, in characters, of data items at the specified index.

Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
Public Overridable Function GetItemMaxLength ( _
    index As Integer _
) As Integer

public virtual int GetItemMaxLength(
    int index
)

public:
virtual int GetItemMaxLength(
    int index
)

abstract GetItemMaxLength : 
        index:int -> int  
override GetItemMaxLength : 
        index:int -> int

public function GetItemMaxLength(
    index : int
) : int

Parameters

index
Type: System.Int32

The index of the data item being examined for length.

Return Value

Type: System.Int32
The maximum length, in number of characters, of the data item at the specified index; or, returns -1 if the maximum length is unavailable or is not sensible.

Implements

IVsDataReaderDescriptor.GetItemMaxLength(Int32)

Remarks

Notes to Inheritors

The base implementation returns -1. The derived class should override this method.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via