Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

SqlParameter.Offset Property

.NET Framework 4

Gets or sets the offset to the Value property.

Namespace:  System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)
C#
C++
F#
VB
Copy 
[BrowsableAttribute(false)]
public int Offset { get; set; }

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.

C#
VB
Copy 

static void CreateSqlParameterOffset()
{
    SqlParameter parameter = new SqlParameter("pDName", SqlDbType.VarChar);
    parameter.IsNullable = true;
    parameter.Offset = 3;
}

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ