sqloptions:clientPID ヘッダー要素
sqloptions:clientPID ログイン オプションを使用すると、ログインに使用するクライアント プロセス ID をクライアントから指定できます。次に例を示します。
<SOAP-ENV:Header
xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:sqloptions="https://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
<sqloptions:clientPID
SOAP-ENV:mustUnderstand="1"
value="ID of client process "/>
</SOAP-ENV:Header>
sqloptions:clientPID ログイン オプションは SOAP ヘッダーとして使用します。構成要素は sqloptions:clientPID 1 つのみです。この要素には 1 つの必須の属性 value があります。この属性の値は長整数値 (64 ビット符号付き) です。value 属性には、ログインに設定するクライアント プロセス ID を指定します。この値は sys.sysprocesses 互換性ビューの hostprocess 列に表示されます。
sqloptions:clientPID オプションは 1 回の要求で 1 回のみ使用できます。このオプションを応答に使用することはできません。このオプションが複数存在するとエラーが発生します。
sqloptions:clientPID の値として認識される値の範囲がサーバーで制限される場合があります。クライアントが許容範囲外の値を送信すると、値はサーバーで自動的に切り捨てられますが、その方法は一定ではありません。
SOAP セッションを使用しているときは、sqloptions:sqlsession initiate 属性と同一の要求でこのオプションを使用する必要があります。initiate 属性が指定されていない sqloptions:sqlSession ヘッダーを含んだ要求にこのオプションが指定されると、エラーが発生します。
次に、スキーマの sqloptions:clientPID オプションに関する部分を示します。
<xs:element name="clientPID" form="qualified">
<xs:annotation>
<xs:documentation>
Set the client process ID for the login.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute use="required" name="value" type="xs:long" form="unqualified">
<xs:annotation>
<xs:documentation>
The client process ID to set for the login.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
例
次に、SOAP 要求メッセージと応答メッセージ内で sqloptions:clientPID ヘッダーを使用する例を示します。
要求
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:sql="https://schemas.microsoft.com/sqlserver/2004/SOAP"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:sqlparam="https://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlParameter"
xmlns:sqlsoaptypes="https://schemas.microsoft.com/sqlserver/2004/SOAP/types"
xmlns:sqloptions="https://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
<SOAP-ENV:Header>
<sqloptions:clientPID SOAP-ENV:mustUnderstand="1" value="1234" />
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sql:sqlbatch>
<sql:BatchCommands>
SELECT hostprocess FROM sysprocesses WHERE spid=@@spid AND hostprocess='1234'
</sql:BatchCommands>
</sql:sqlbatch>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
応答
<SOAP-ENV:Envelope xml:space="preserve"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:sql="https://schemas.microsoft.com/sqlserver/2004/SOAP"
xmlns:sqlsoaptypes="https://schemas.microsoft.com/sqlserver/2004/SOAP/types"
xmlns:sqlrowcount="https://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlRowCount"
xmlns:sqlmessage="https://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlMessage"
xmlns:sqlresultstream="https://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlResultStream"
xmlns:sqltransaction="https://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlTransaction"
xmlns:sqltypes="https://schemas.microsoft.com/sqlserver/2004/sqltypes">
<SOAP-ENV:Body>
<sql:sqlbatchResponse>
<sql:sqlbatchResult>
<sqlresultstream:SqlRowSet xsi:type="sqlsoaptypes:SqlRowSet">
<diffgr:diffgram xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">
<SqlRowSet1 xmlns="urn:schemas-microsoft-com:sql:SqlRowSet1">
<row>
<hostprocess>1234</hostprocess>
</row>
</SqlRowSet1>
</diffgr:diffgram>
</sqlresultstream:SqlRowSet>
<sqlresultstream:SqlRowCount xsi:type="sqlrowcount:SqlRowCount">
<sqlrowcount:Count>1</sqlrowcount:Count>
</sqlresultstream:SqlRowCount>
</sql:sqlbatchResult>
</sql:sqlbatchResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>