次の方法で共有

  • [アーティクル]

sqloptions:environmentChangeNotifications ヘッダー要素

この機能は、将来のバージョンの Microsoft SQL Server では削除される予定です。新しい開発作業では、この機能の使用を避け、現在この機能を使用しているアプリケーションは修正するようにしてください。

クライアントは sqloptions:environmentChangeNotifications SOAP ヘッダーを使用して、受信する環境変更の通知を指定できます。次に例を示します。

<SOAP-ENV:Header
  xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
  xmlns:sqloptions="https://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
<sqloptions:environmentChangeNotifications           SOAP-ENV:mustUnderstand="1"         databaseChange="true" | "false"          languageChange="true" | "false"          transactionBoundary="true" | "false"  />
</SOAP-ENV:Header>

sqloptions:environmentChangeNotifications オプションは SOAP ヘッダーとして指定します。ヘッダーは、sqloptions:environmentChangeNotifications という 1 つの要素で構成されています。この要素には databaseChange、languageChange、partnerChange、および transactionBoundary という 4 つの省略可能な属性があり、いずれもブール値です。4 つの属性の既定値はいずれも false です。この属性で、クライアントが受信する通知を指定します。

sqloptions:environmentChangeNotifications オプションは 1 回の要求で 1 回のみ使用できます。このオプションを応答に使用することはできません。sqloptions:environmentChangeNotifications ノードに内容が含まれている場合、またはこのオプションが複数存在する場合はエラーが発生します。

SOAP セッションを使用しているときは、sqloptions:sqlsession initiate 属性と同一の要求でこのオプションを使用する必要があります。initiate 属性も指定されていない sqloptions:sqlSession ヘッダーを含んだ要求にこのオプションが指定されると、エラーが発生します。

次に、スキーマの sqloptions:environmentChangeNotifications オプションに関する部分を示します。

<xs:element name="environmentChangeNotifications" form="qualified">
    <xs:annotation>
        <xs:documentation>
            Receive environment change notifications.
        </xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:attribute
          name="databaseChange"
          default="false"
          type="xs:boolean"
          form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    Receive notifications of database changes.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute
          name="languageChange"
          default="false"
          type="xs:boolean"
          form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    Receive notifications of language changes.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute
          name="transactionBoundary"
          default="false"
          type="xs:boolean"
          form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    Receive notifications of transaction boundaries.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="partnerChange" default="false" type="xsd:boolean" form="unqualified">
            <xs:annotation>
                <xs:documentation>Receive notifications of partner changes.</xs:documentation> 
            </xs:annotation>
         </xs:attribute>
    </xs:complexType>
</xs:element>

例

次に、SOAP 要求メッセージと応答メッセージ内で sqloptions:environmentChangeNotifications ヘッダーを使用する例を示します。

要求

POST !HTTPURL! HTTP/1.1
Content-Type: text/xml
Host: !SERVERNAME!
SOAPAction: "https://schemas.microsoft.com/sqlserver/2004/SOAPsqlbatch"
<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:environmentChangeNotifications           SOAP-ENV:mustUnderstand="1"         databaseChange="true"          languageChange="true"          transactionBoundary="true" />
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <sql:sqlbatch>
      <sql:BatchCommands>
         SET LANGUAGE Italian
         SELECT @@LANGUAGE as lang   
         USE  AdventureWorks2008R2
         BEGIN TRANSACTION testTransaction
         SELECT @@LANGUAGE as language
         COMMIT TRANSACTION testTransaction
       </sql:BatchCommands>
     </sql:sqlbatch>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

応答

<Response>
  <Version>HTTP/1.1</Version>
  <Status>200</Status>
  <StatusText>OK</StatusText>
  <Headers>
    <Content-Type>text/xml; charset=utf-8</Content-Type>
    <Date>exists</Date>
    <Server>Microsoft-SQL/9.0 Microsoft-HTTPAPI/1.0</Server>
    <Transfer-Encoding>chunked</Transfer-Encoding>
  </Headers>
  <Body>
    <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:SqlMessage xsi:type="sqlmessage:SqlMessage">
              <sqlmessage:Class>0</sqlmessage:Class>
              <sqlmessage:LineNumber>0</sqlmessage:LineNumber>
              <sqlmessage:Message>Changed language setting to Italiano.</sqlmessage:Message>
              <sqlmessage:Number>5703</sqlmessage:Number>
              <sqlmessage:Source>Microsoft-SQL/9.0</sqlmessage:Source>
              <sqlmessage:State>1</sqlmessage:State>
            </sqlresultstream:SqlMessage>
            <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>
                    <lang>Italiano</lang>
                  </row>
                </SqlRowSet1>
              </diffgr:diffgram>
            </sqlresultstream:SqlRowSet>
            <sqlresultstream:SqlRowCount xsi:type="sqlrowcount:SqlRowCount">
              <sqlrowcount:Count>1</sqlrowcount:Count>
            </sqlresultstream:SqlRowCount>
            <sqlresultstream:SqlMessage xsi:type="sqlmessage:SqlMessage">
              <sqlmessage:Class>0</sqlmessage:Class>
              <sqlmessage:LineNumber>0</sqlmessage:LineNumber>
              <sqlmessage:Message>Changed database context to 'Northwind'.</sqlmessage:Message>
              <sqlmessage:Number>5701</sqlmessage:Number>
              <sqlmessage:Source>Microsoft-SQL/9.0</sqlmessage:Source>
              <sqlmessage:State>1</sqlmessage:State>
            </sqlresultstream:SqlMessage>
            <sqlresultstream:SqlTransaction xsi:type="sqltransaction:SqlTransaction">
              <sqltransaction:Descriptor>asdf</sqltransaction:Descriptor>
              <sqltransaction:Type>Begin</sqltransaction:Type>
            </sqlresultstream:SqlTransaction>
            <sqlresultstream:SqlRowSet xsi:type="sqlsoaptypes:SqlRowSet">
              <diffgr:diffgram xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">
                <SqlRowSet2 xmlns="urn:schemas-microsoft-com:sql:SqlRowSet2">
                  <row>
                    <language>Italiano</language>
                  </row>
                </SqlRowSet2>
              </diffgr:diffgram>
            </sqlresultstream:SqlRowSet>
            <sqlresultstream:SqlRowCount xsi:type="sqlrowcount:SqlRowCount">
              <sqlrowcount:Count>1</sqlrowcount:Count>
            </sqlresultstream:SqlRowCount>
            <sqlresultstream:SqlTransaction xsi:type="sqltransaction:SqlTransaction">
              <sqltransaction:Descriptor>asdf</sqltransaction:Descriptor>
              <sqltransaction:Type>Commit</sqltransaction:Type>
            </sqlresultstream:SqlTransaction>
          </sql:sqlbatchResult>
        </sql:sqlbatchResponse>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
  </Body>
</Response>

関連項目

参照

SOAP 拡張ヘッダー