DataTableReader.GetGuid Method (Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the value of the specified column as a globally-unique identifier (GUID).

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

Public Overrides Function GetGuid (
	ordinal As Integer
) As Guid

Parameters

ordinal
Type: System.Int32

The zero-based column ordinal.

Return Value

Type: System.Guid

The value of the specified column.

Exception Condition
ArgumentOutOfRangeException

The index passed was outside the range of 0 to FieldCount - 1.

DeletedRowInaccessibleException

An attempt was made to retrieve data from a deleted row.

InvalidOperationException

An attempt was made to read or access a column in a closed DataTableReader.

InvalidCastException

The specified column does not contain a GUID.

No conversions are performed; therefore the data retrieved must already be a Guid or coercible to a Guid.

Call IsDBNull to see if there are null values before calling this method.

The following example displays the contents of the column numbered 2 within the passed-in DataTableReader. If the value the column within a particular row is null, the code displays the text <NULL>. If the data within the column is not of the correct type, the example displays an error message for each row.

Private Sub PrintColumn(ByVal reader As DataTableReader)
   ' Loop through all the rows in the DataTableReader
   While reader.Read()
      If reader.IsDBNull(2) Then
         Console.Write("<NULL>")
      Else
         Try
            Console.Write(reader.GetGuid(2))
         Catch ex As InvalidCastException
            Console.Write("Invalid data type.")
         End Try
      End If
      Console.WriteLine()
   End While
End Sub

.NET Framework
Available since 2.0
Return to top
Show: