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

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

クライアントにメッセージを送信します。

構文

int srv_sendmsg (
SRV_PROC *
srvproc
,
int
msgtype
,
DBINT
msgnum
,
DBTINYINT
class
, 
DBTINYINT
state
,
DBCHAR *
rpcname
,
int 
rpcnamelen
,
DBUSMALLINT
linenum
,
DBCHAR *
message
,
int
msglen 
);

引数

• srvproc
  特定のクライアント接続のためのハンドル (この場合は、言語要求を受け取るハンドル) である SRV_PROC 構造体を指すポインタです。この構造体には、アプリケーションとクライアントの間の通信やデータを管理するために、拡張ストアド プロシージャ API ライブラリで使用する情報が格納されます。

• msgtype
  サーバーから送信されるメッセージの種類が情報メッセージかエラー メッセージかによって、SRV_MSG_INFO または SRV_MSG_ERROR を指定します。

• msgnum
  4 バイトのメッセージ番号です。

• class
  エラーの重大度を指定します。重大度が 10 以下の場合は、情報メッセージと見なされます。

• state
  現在のメッセージのエラー状態番号を指定します。エラー状態番号により、エラーの内容に関する情報を得ることができます。有効な状態番号の範囲は 0 ～ 255 です。

• rpcname
  現時点では、サポートされません。

• rpcnamelen
  現時点では、サポートされません。

• linenum
  メッセージが該当する言語コマンド バッチ内の行番号です。行番号は 1 から始まります。メッセージに linenum が不要である場合は、0 に設定します。

• message
  クライアントに送信される文字列を指すポインタです。

• msglen
  message の長さをバイト数で指定します。message が NULL 終端である場合は、msglen を SRV_NULLTERM に設定します。

戻り値

SUCCEED または FAIL を返します。

解説

この関数は、エラー メッセージまたは情報メッセージをクライアントに送信する場合に使用します。メッセージが送信されるたびに呼び出されます。

メッセージは、srv_sendrow によるすべての行 (あれば) の送信前後に任意の順序で srv_sendmsg を使用してクライアントに送信できます。すべてのメッセージ (あれば) は srv_senddone で完了状態が送信される前にクライアントに送信しておく必要があります。

Unicode でメッセージを送信するには、srv_sendmsg ではなく srv_wsendmsg を使用してください。

詳細については、「Unicode データおよびサーバー コード ページ」を参照してください。

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