PipelineBuffer.GetGuid Method

Gets the Guid value stored in the PipelineBuffer column.

This API is not CLS-compliant. 

Namespace:  Microsoft.SqlServer.Dts.Pipeline
Assembly:  Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Function GetGuid ( _
    columnIndex As Integer _
) As Guid
'Usage
Dim instance As PipelineBuffer
Dim columnIndex As Integer
Dim returnValue As Guid

returnValue = instance.GetGuid(columnIndex)
[CLSCompliantAttribute(false)]
public Guid GetGuid(
    int columnIndex
)
[CLSCompliantAttribute(false)]
public:
Guid GetGuid(
    int columnIndex
)
[<CLSCompliantAttribute(false)>]
member GetGuid : 
        columnIndex:int -> Guid 
public function GetGuid(
    columnIndex : int
) : Guid

Parameters

Return Value

Type: System.Guid
The Guid value stored in the PipelineBuffer column.

Remarks

This method works with the DT_GUID data type in Integration Services.

If the value of the column is null, the PipelineBuffer produces a ColumnIsNullException. You should first check for null by calling the IsNull method before retrieving the Guid from the buffer column.

For a complete list of Integration Services data types and the corresponding Get and Set methods of the PipelineBuffer class to use with each type, see Working with Data Types in the Data Flow.