Élément d'en-tête sqloptions:clientInterface
L'option de connexion sqloptions:clientInterface permet au client de spécifier l'interface cliente pour la connexion, par exemple :
<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>
L'option de connexion sqloptions:clientInterface apparaît sous la forme d'un en-tête SOAP et se compose d'un seul élément appelé sqloptions:clientInterface. Cet élément possède un attribut obligatoire, value (valeur texte), qui permet de définir l'interface cliente pour la connexion. Cet élément se trouve dans la colonne client_interface_name de la vue de compatibilité sys.dm_exec_sessions.
Une demande ne peut contenir qu'une seule instance de l'option sqloptions:clientInterface, qui ne peut en outre pas apparaître dans une réponse. La présence de plusieurs instances de cette option génère une erreur.
Le serveur peut limiter la plage des valeurs reconnues de sqloptions:clientInterface. Si un client soumet une valeur non comprise dans la plage autorisée, le serveur tronque automatiquement la valeur de manière indéterminée.
Pour les sessions SOAP, cette option doit apparaître dans la même demande que l'attribut sqloptions:sqlsession initiate. Si elle apparaît dans une demande avec un en-tête sqloptions:sqlSession sans attribut initiate, une erreur est générée.
Vous trouverez ci-dessous un fragment de schéma pour l'option 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>
Exemples
Vous trouverez ci-dessous quelques exemples d'utilisation de l'en-tête sqloptions:clientInterface dans une demande SOAP et des messages de réponse.
Demande
<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>
Réponse
<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>