sqloptions:initialLanguage ヘッダー要素
sqloptions:initialLanguage SOAP ヘッダーを使用すると、クライアントが初期設定言語を指定できます。次に例を示します。
<SOAP-ENV:Header
xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:sqloptions="https://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
<sqloptions:initialLanguage
SOAP-ENV:mustUnderstand="1"
value="name of initial language to use"
optional="true" | "false" />
</SOAP-ENV:Header>
sqloptions:initialLanguage オプションは SOAP ヘッダーとして指定します。ヘッダーは、sqloptions:initialLanguage という 1 つの要素で構成されています。この要素には 1 つの必須の属性 value があります。これは文字列値です。value 属性には、設定する初期設定の言語の名前を指定します。この文字列は、SET LANGUAGE Transact-SQL ステートメントと同様に解釈されます。この要素には 1 つの省略可能な属性 optional があります。指定するのはブール値です (既定値は false) です)。この属性には、データベースへの接続が失敗した場合にログインを失敗させるかどうかを指定します。false を指定した場合はログインを失敗とし、true を指定した場合はログインを続行します。
sqloptions:initialLanguage オプションは 1 回の要求で 1 回のみ使用できます。このオプションを応答に使用することはできません。このオプションが複数存在するとエラーが発生します。
SOAP セッションを使用しているときは、sqloptions:sqlsession initiate 属性と同一の要求でこのオプションを使用する必要があります。initiate 属性も指定されていない sqloptions:sqlSession ヘッダーを含んだ要求にこのオプションが指定されると、エラーが発生します。
次に、スキーマの sqloptions:initialLanguage オプションに関する部分を示します。
<xs:element name="initialLanguage" form="qualified">
<xs:annotation>
<xs:documentation>
Set initial language to set.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute use="required" name="value" type="xs:string" form="unqualified">
<xs:annotation>
<xs:documentation>
The name of the initial language to set.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute
name="optional"
default="false"
type="xs:boolean"
form="unqualified">
<xs:annotation>
<xs:documentation>
Whether the initial language is optional or not.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
例
次に、SOAP 要求メッセージと応答メッセージ内で sqloptions:initialLanguage ヘッダーを使用する例を示します。
要求
<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:initialLanguage SOAP-ENV:mustUnderstand="1" value="us_english" optional="true"/>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sql:sqlbatch>
<sql:BatchCommands>
SELECT @@language AS lang
</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>
<lang>us_english</lang>
</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>