OdbcParameter.Size プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

OdbcParameter.Size プロパティ

列内のデータの最大サイズを取得または設定します。

名前空間: System.Data.Odbc
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Overrides Property
 Size As Integer

Visual Basic (使用法)

Dim instance As OdbcParameter
Dim value As Integer

value = instance.Size

instance.Size = value

public override int Size { get;
 set; }

C++

public:
virtual property int Size {
    int get () override;
    void set (int value)
 override;
}

/** @property */
public int get_Size ()

/** @property */
public void set_Size (int
 value)

JScript

public override function get
 Size () : int

public override function set
 Size (value : int)

プロパティ値
列内のデータの最大サイズ。既定値は、パラメータ値から推論されます。

解説

Size プロパティは、バイナリ型と文字列型で使用します。

文字列以外のデータ型および ANSI 文字列データでは、Size プロパティは、バイト数を示します。Unicode 文字列データでは、Size は、文字数を示します。文字列の文字数に、終端文字は含まれません。

可変長データ型では、Size は、サーバーに送信するデータの最大量を示します。たとえば、Unicode 文字列の場合、Size を使用して、サーバーに送信されるデータ量を先頭から 100 文字までに制限できます。

両方向パラメータ、出力パラメータ、および戻り値では、Size を指定する必要があります。これは、入力パラメータの場合は不要です。明示的に設定しなかった場合、値は、パラメータ化されたステートメントの実行時に、指定したパラメータの実際のサイズから推論されます。

パラメータの DbType プロパティ、OdbcType プロパティ、および Size プロパティは、Value を設定することによって推論できます。したがって、これらを指定する必要はありません。ただし、これらは OdbcParameter プロパティの設定値に公開されません。たとえば、パラメータのサイズが推論された場合、Size はステートメントの実行後に推論値を格納しません。

メモ
Direction が ParameterDirection.Output、ParameterDirection.InputOutput、または ParameterDirection.ReturnValue のOdbcParameter では、コマンドが実行され、データソースから返された値のサイズが OdbcParameter の Size で指定した値を超えると、例外がスローされます。

固定長データ型では、Size の値は無視されます。この値は、情報として利用できます。この値を取得して返される値は、パラメータの値をサーバーに送信するときにプロバイダが使用する最大バイト量を示します。

使用例

OdbcParameter を作成し、そのプロパティの一部を設定する例を次に示します。

[Visual Basic]

Public Sub CreateOdbcParameter()
    Dim myValue As String = "12 foot scarf - multiple colors, one previous owner"
    Dim parameter As New OdbcParameter("Description", OdbcType.VarChar)
    parameter.Direction = ParameterDirection.Output
    parameter.Size = myValue.Length
    parameter.Value = myValue
End Sub

[C#]

public void CreateOdbcParameter() 
 {
    string myValue = "12 foot scarf - multiple colors, one previous owner";
    OdbcParameter parameter = new OdbcParameter("Description", OdbcType.VarChar);
    parameter.Direction = ParameterDirection.Output;
    parameter.Size = myValue.Length;
    parameter.Value = myValue;
 }