sqloptions:applicationName ヘッダー要素
sqloptions:applicationName ログイン オプションを使用すると、次の例に示すようにログインに使用するアプリケーションの名前をクライアントから指定できます。
<SOAP-ENV:Header
xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:sqloptions="https://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
<SOAP-ENV:Header>
<sqloptions:applicationName SOAP-ENV:mustUnderstand="1" value="application name" />
</SOAP-ENV:Header>
<SOAP-ENV:Body>
</SOAP-ENV:Body>
</SOAP-ENV:Header>
sqloptions:applicationName ログイン オプションは SOAP ヘッダーとして使用します。構成要素は sqloptions:applicationName のみです。この要素には 1 つの必須属性 value があります。この属性は文字列です。value 属性には、ログインに設定する "application name" を指定します。この値は sys.sysprocesses 互換性ビューの program_name 列に表示されます。
sqloptions:applicationName ヘッダーの指定は省略可能ですが、使用する場合は 1 つの SOAP 要求に 1 つだけ指定できます。このヘッダーを SOAP 応答に使用することはできません。このオプションが複数存在するとエラーが発生します。
sqloptions:applicationName の値として認識される値の範囲がサーバーで制限される場合があります。クライアントが許容範囲外の値を送信すると、値はサーバーで自動的に切り捨てられますが、その方法は一定ではありません。
SOAP セッションの使用中は、SOAP セッションを開始するために使用したのと同じ要求にこのオプションが指定されている必要があります。initiate 属性が指定されていない sqloptions:sqlSession ヘッダーを含んだ要求にこのオプションが指定されると、エラーが発生します。
次に、スキーマの sqloptions:applicationName オプションに関する部分を示します。
<xs:element name="applicationName" form="qualified">
<xs:annotation>
<xs:documentation>
Set the application name for the login.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute use="required" name="value" type="xs:string" form="unqualified">
<xs:annotation>
<xs:documentation>
The application name to set for the login.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
例
次に、SOAP 要求メッセージと応答メッセージ内で sqloptions:applicationName ヘッダーを使用する例を示します。
要求
<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:applicationName SOAP-ENV:mustUnderstand="1" value="HeadTrax" />
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sql:sqlbatch>
<sql:BatchCommands>
SELECT DISTINCT program_name FROM sysprocesses
WHERE program_name='HeadTrax'
</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>
<program_name>HeadTrax</program_name>
</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>