SqlParameter.Offset Property

Definition

Gets or sets the offset to the Value property.

public:
 property int Offset { int get(); void set(int value); };
[System.ComponentModel.Browsable(false)]
[System.Data.DataSysDescription("SqlParameter_Offset")]
public int Offset { get; set; }
member this.Offset : int with get, set
Public Property Offset As Integer

Property Value

The offset to the Value. The default is 0.

Attributes

Examples

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

static void CreateSqlParameterOffset()
{
    SqlParameter parameter = new SqlParameter("pDName", SqlDbType.VarChar);
    parameter.IsNullable = true;
    parameter.Offset = 3;
}
Private Sub CreateSqlParameterOffset()
    Dim parameter As New SqlParameter("pDName", SqlDbType.VarChar)
    parameter.IsNullable = True
    parameter.Offset = 3
End Sub

Remarks

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.

Applies to

See also