Elemento de cabeçalho sqloptions:applicationName
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:applicationName permite ao cliente especificar o nome do aplicativo usado no 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">
<SOAP-ENV:Header>
<sqloptions:applicationName SOAP-ENV:mustUnderstand="1" value="application name" />
</SOAP-ENV:Header>
<SOAP-ENV:Body>
</SOAP-ENV:Body>
</SOAP-ENV:Header>
A opção de logon sqloptions:applicationName é exibida como um cabeçalho SOAP. Ela é composta por um elemento, denominado sqloptions:applicationName. O elemento tem um atributo obrigatório, value. Esse atributo é uma cadeia de caracteres. O atributo value dá o "nome do aplicativo" a ser definido para o logon. Isso aparece na coluna program_name da exibição de compatibilidade sys.sysprocesses.
Apenas uma instância do cabeçalho opcional sqloptions:applicationName pode ser exibida em uma única solicitação SOAP. Esse cabeçalho não pode ser exibido em uma resposta SOAP. Várias instâncias da opção gerarão um erro.
O servidor pode limitar o intervalo de valores reconhecidos do valor sqloptions:applicationName. Se um cliente enviar um valor fora do intervalo permitido, o servidor truncará o valor silenciosamente de uma maneira indefinida.
Se estiverem sendo usadas sessões SOAP, essa opção deverá ser exibida na mesma solicitação usada para iniciar uma sessão SOAP. Se essa opção for exibida em qualquer solicitação com um cabeçalho sqloptions:sqlSession que também não contém o atributo initiate, será gerado um erro.
A seguir, é mostrado um fragmento do esquema para a opção sqloptions:applicationName:
<xs:element name="applicationName" form="qualified">
<xs:annotation>
<xs:documentation>
Set the application name 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 application name 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:applicationName 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:applicationName SOAP-ENV:mustUnderstand="1" value="HeadTrax" />
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sql:sqlbatch>
<sql:BatchCommands>
SELECT DISTINCT program_name FROM sysprocesses
WHERE program_name='HeadTrax'
</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>
<program_name>HeadTrax</program_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>