ScriptBuffer.SetNull Method

Article
12/03/2008

Makes the value of the specified column null.

Namespace: Microsoft.SqlServer.Dts.Pipeline
Assembly: Microsoft.SqlServer.TxScript (in microsoft.sqlserver.txscript.dll)

Syntax

'Declaration
Protected Sub SetNull ( _
    ColumnIndex As Integer _
)

protected void SetNull (
    int ColumnIndex
)

protected:
void SetNull (
    int ColumnIndex
)

protected void SetNull (
    int ColumnIndex
)

protected function SetNull (
    ColumnIndex : int
)

Parameters

ColumnIndex
The index of the column.

Remarks

The Script component developer does not use the ScriptBuffer class directly, but indirectly, through the derived classes in the BufferWrapper project item that represent the component's input and outputs.

The developer does not have to use the SetNull method, because the derived classes contain a <ColumnX>_IsNull property for each column that you can use to specify a null value.

Example

The following sample code from the autogenerated BufferWrapper project item demonstrates how the Script component uses the SetNull method.

    Public WriteOnly Property [city_IsNull] As Boolean
        Set
            SetNull(1)
        End Set
    End Property

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