Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

IDataRecord.GetString Method

.NET Framework 4

Gets the string value of the specified field.

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)
C#
C++
F#
VB
Copy 
string GetString(
	int i
)

Parameters

i
Type: System.Int32
The index of the field to find.

Return Value

Type: System.String
The string value of the specified field.
Exception Condition
IndexOutOfRangeException

The index passed was outside the range of 0 through FieldCount.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Other Exceptions
For the SqlDataReader implementation, GetString will throw an exception if the value is null.  When implementing this method, is it suggested/required to follow this pattern?  A class that I am working on is going to implement this interface, and for now I think I will stick to this precendent since consumers of the class may expect it.
History
Also throws exception for invalid cast
The documentation only lists one exception, but bear in mind that this also throws an exception if it can't cast the field as a string.  I got the following error in my code: 
[Unable to cast object of type 'System.Int16' to type 'System.String'.]

That's pretty annoying actually, since I would have thought the GetString method could handle an Int16 object, but anyway, be aware.


        

        

            History