SqlParameter.Offset Property
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the offset to the Value property.
public:
property int Offset { int get(); void set(int value); };
[System.ComponentModel.Browsable(false)]
public int Offset { get; set; }
public int Offset { get; set; }
[<System.ComponentModel.Browsable(false)>]
member this.Offset : int with get, set
member this.Offset : int with get, set
Public Property Offset As Integer
The offset to the Value. The default is 0.
- Attributes
The following example creates a SqlParameter and sets some of its properties.
// using Microsoft.Data.SqlClient;
static void CreateSqlParameterOffset()
{
SqlParameter parameter = new SqlParameter("pDName", SqlDbType.VarChar);
parameter.IsNullable = true;
parameter.Offset = 3;
}
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.
Product | Versions |
---|---|
SqlClient .NET Core | 1.0, 1.1, 2.0, 2.1, 3.0, 3.1, 4.0, 4.1, 5.0, 5.1, 5.2 |
SqlClient .NET Framework | 1.0, 1.1, 2.0, 2.1, 3.0, 3.1, 4.0, 4.1, 5.0, 5.1, 5.2 |
SqlClient .NET Standard | 1.0, 1.1, 2.0, 2.1, 3.0, 3.1, 4.0, 4.1, 5.0, 5.1, 5.2 |