sqloptions:clientInterface (elemento de encabezado)
Esta característica se quitará en una versión futura de Microsoft SQL Server. Evite utilizar esta característica en nuevos trabajos de desarrollo y tenga previsto modificar las aplicaciones que actualmente la utilizan.
La opción de inicio de sesión sqloptions:clientInterface permite al cliente especificar la interfaz cliente para el inicio de sesión; por ejemplo:
<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>
La opción de inicio de sesión sqloptions:clientInterface aparece como un encabezado SOAP. Se compone de un elemento denominado sqloptions:clientInterface. El elemento tiene un atributo obligatorio, value, que es un valor de texto. Este atributo proporciona la interfaz cliente que se establece para el inicio de sesión. La interfaz aparece en la columna client_interface_name de la vista de compatibilidad sys.dm_exec_sessions.
Solo puede aparecer una instancia de la opción sqloptions:clientInterface en una solicitud. La opción no puede aparecer en una respuesta. La presencia de varias instancias de la opción generará un error.
Puede que el servidor limite el intervalo de valores reconocidos del valor sqloptions:clientInterface. Si un cliente envía un valor que está fuera del intervalo permitido, el servidor truncará sin avisar el valor de manera indefinida.
Si se utilizan sesiones SOAP, esta opción debe aparecer en la misma solicitud que el atributo sqloptions:sqlsession initiate. Si esta opción aparece en alguna solicitud con un encabezado sqloptions:sqlSession que no contiene también un atributo initiate, se genera un error.
A continuación se muestra un fragmento de esquema de la opción 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>
Ejemplos
A continuación se muestran ejemplos de utilización del encabezado sqloptions:clientInterface en mensajes de solicitud y respuesta SOAP.
Solicitud
<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>
Respuesta
<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>