Elemento de cabeçalho sqloptions:clientInterface
Esse recurso será removido em uma versão futura do Microsoft SQL Server. Evite usar esse recurso em desenvolvimentos novos e planeje modificar os aplicativos que atualmente o utilizam.
A opção de logon sqloptions:clientInterface permite que o cliente especifique a interface cliente para o logon, por exemplo:
<SOAP-ENV:Header
xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:sqloptions="https://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
<sqloptions:clientInterface SOAP-ENV:mustUnderstand="1" value="name of client interface to use for login" />
</SOAP-ENV:Header>
A opção de logon sqloptions:clientInterface é exibida como um cabeçalho SOAP. Ela é composta por um elemento, denominado sqloptions:clientInterface. O elemento tem um atributo obrigatório, value, que é um valor de texto. Ele fornece a interface cliente a ser definida para o logon. A interface aparece na coluna client_interface_name da exibição de compatibilidade sys.dm_exec_sessions.
Só uma instância da opção sqloptions:clientInterface pode aparecer em uma solicitação. A opção não pode aparecer em uma resposta. Várias instâncias da opção gerarão um erro.
O servidor pode limitar o intervalo de valores reconhecidos do valor sqloptions:clientInterface. Se um cliente enviar um valor fora do intervalo permitido, o servidor truncará o valor silenciosamente de uma maneira indefinida.
Se forem usadas sessões SOAP, esta opção deverá ser exibida na mesma solicitação que o atributo sqloptions: sqlsession initiate. Se essa opção for exibida em qualquer solicitação com um cabeçalho sqloptions:sqlSession que também não contém um atributo initiate, será gerado um erro.
A seguir, é mostrado um fragmento do esquema para a opção sqloptions:clientInterface:
<xs:element name="clientInterface" form="qualified">
<xs:annotation>
<xs:documentation>
Set the client interface 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 client interface to set for the login.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Exemplos
Seguem exemplos de utilização do cabeçalho sqloptions:clientInterface em mensagens de solicitação e resposta do protocolo SOAP.
Solicitação
<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:clientInterface SOAP-ENV:mustUnderstand="1" value="ADO.NET SOAP 2.1" />
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sql:sqlbatch>
<sql:BatchCommands>
SELECT client_interface_name FROM sys.dm_exec_sessions
WHERE session_id=@@spid AND client_interface_name='ADO.NET SOAP 2.1'
</sql:BatchCommands>
</sql:sqlbatch>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Resposta
<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>
<client_interface_name>ADO.NET SOAP 2.1</client_interface_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>