srv_paraminfo (拡張ストアド プロシージャ API)

  • [アーティクル]

適用対象:SQL Server

重要

この機能は、 SQL Serverの将来のバージョンで削除される予定です。 新規の開発作業ではこの機能を使用しないようにし、現在この機能を使用しているアプリケーションは修正することを検討してください。 代わりに CLR 統合を使用してください。

パラメーターに関する情報を返します。 この関数は、srv_paramtype、srv_paramlen、srv_parammaxlen、および srv_paramdata に代わる関数です。 srv_paraminfo では、「データ型 (拡張ストアド プロシージャ API)」に記載されているデータ型、および長さがゼロのデータをサポートします。

構文

  
int srv_paraminfo (  
SRV_PROC *  
srvproc  
,  
int  
n  
,  
BYTE *  
pbType  
,  
ULONG *  
pcbMaxLen  
,  
ULONG *  
pcbActualLen  
,  
BYTE *  
pbData  
,  
BOOL *  
pfNull  
);

引数

srvproc
クライアント接続のためのハンドルです。

n
設定するパラメーターの序数です。 最初のパラメーターは 1 です。

pbType
パラメーターのデータ型です。

pcbMaxLen
パラメーターの最大長へのポインターです。

pcbActualLen
パラメーターの実際の長さへのポインターです。 値 0 (*pcbActualLen == 0) は、*pfNull が FAL Standard Edition に設定されている場合、長さ 0 のデータを示します。

pbData
パラメーター データのバッファーへのポインターです。 pbData が NULL でない場合、拡張ストア プロシージャ API は *pcbActualLen バイトのデータを *pbData に書き込みます。 pbData が NULL の場合、*pbData にデータは書き込まれず、関数は *pbType、*pcbMaxLen、*pcbActualLen、および *pfNull を返します。 このバッファーのメモリは、アプリケーションで管理する必要があります。

pfNull
NULL フラグへのポインターです。このパラメーターの値が NULL である場合、 *pfNull は TRUE に設定されます。

返品

パラメーター情報が正常に取得された場合は SUCCEED を返し、それ以外の場合は FAIL を返します。 FAIL が返されるのは、現在のリモート ストアド プロシージャがない場合、および n 番目のリモート ストアド プロシージャ パラメーターがない場合です。

解説

セキュリティに関する注意 拡張ストアド プロシージャのソース コードを十分に確認し、コンパイルした DLL をテストしたうえで実稼働サーバーにインストールしてください。 セキュリティの確認およびテストについて詳しくは、Microsoft の Web サイトをご覧ください。

参照

拡張ストアド プロシージャのプログラマーズ リファレンス