SqlParameter.Offset Property


Gets or sets the offset to the Value property.

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

Public Property Offset As Integer

Property Value

Type: System.Int32

The offset to the Value. The default is 0.

The Offset property is used for client-side chunking of binary and string data. For example, in order to insert 10MB of text into a column on a server, a user might execute 10 parameterized inserts of 1MB chunks, shifting the value of Offset on each iteration by 1MB.

Offset specifies the number of bytes for binary types, and the number of characters for strings. The count for strings does not include the terminating character.

The following example creates a SqlParameter and sets some of its properties.

Private Sub CreateSqlParameterOffset()
    Dim parameter As New SqlParameter("pDName", SqlDbType.VarChar)
    parameter.IsNullable = True
    parameter.Offset = 3
End Sub

.NET Framework
Available since 1.1
Return to top