CDynamicParameterAccessor::GetParamString

更新 : 2007 年 11 月

バッファに格納されている指定されたパラメータの文字列データを取得します。

bool GetParamString(
   DBORDINAL nParam,
   CSimpleStringA& strOutput
) throw( );
bool GetParamString(
   DBORDINAL nParam,
   CSimpleStringW& strOutput
) throw( );
bool GetParamString(
   DBORDINAL nParam,
   CHAR* pBuffer,
   size_t* pMaxLen
) throw( );
bool GetParamString(
   DBORDINAL nParam,
   WCHAR* pBuffer,
   size_t* pMaxLen
) throw( );

パラメータ

  • nParam
    [入力] パラメータ番号 (開始値 1)。パラメータ 0 は、戻り値のために予約されています。パラメータ番号は、SQL またはストアド プロシージャ呼び出し内でのパラメータの順序に基づくインデックスです。例については、「CDynamicParameterAccessor:SetParam」を参照してください。

  • strOutput
    [出力] 指定したパラメータの ANSI (CSimpleStringA) または Unicode (CSimpleStringW) 文字列データ。たとえば、次のように CString 型のパラメータを渡します。

    CString MyString;
    rs.GetParamString(1, MyString);
    
  • pBuffer
    [出力] 指定したパラメータの ANSI (CHAR) または Unicode (WCHAR) 文字列データ。

  • pMaxLen
    [出力] pBuffer により指定されるバッファのサイズ (末尾の NULL も含む文字数)。

解説

正常に終了した場合は、true を返します。それ以外の場合は、false を返します。

pBuffer が NULL の場合、このメソッドは pMaxLen で指定されたサイズのバッファをメモリ上に確保し、true を返しますが、データのコピーは行いません。

pBuffer のバッファのサイズが、文字列全体を格納するには足りない場合、このメソッドは失敗します。

GetParamString は、バッファから文字列パラメータ データを取得する場合に使用します。バッファから文字列でないパラメータ データを取得するには、GetParam を使ってください。

必要条件

ヘッダー : atldbcli.h

参照

参照

CDynamicParameterAccessor クラス

その他の技術情報

CDynamicParameterAccessor のクラス