Элемент заголовка sqloptions:applicationName

В будущей версии Microsoft SQL Server эта возможность будет удалена. Избегайте использования этой возможности в новых разработках и запланируйте изменение существующих приложений, в которых она применяется.

Параметр имени для входа sqloptions:applicationName позволяет клиенту определить имя приложения, используемого этой учетной записью, например:

<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>

Параметр имени для входа sqloptions:applicationName появляется в качестве заголовка SOAP. Он состоит из одного элемента с именем sqloptions:applicationName. Элемент имеет один обязательный атрибут value. Этот атрибут является строкой. Атрибут value позволяет устанавливать "application name" для имени входа. Оно появляется в столбце program_name представления совместимости sys.sysprocesses.

Только один экземпляр необязательного заголовка sqloptions:applicationName может присутствовать в одиночном запросе SOAP. Данный заголовок не может появляться в ответе SOAP. При наличии нескольких экземпляров параметра будет сформировано сообщение об ошибке.

Сервер может ограничивать диапазон определяемых величин параметра sqloptions:applicationName. Если клиент выдает значение, выходящее за рамки допустимого диапазона, сервер усекает это значение случайным образом, не выдавая сообщения об этом.

Если используются сеансы SOAP, то этот параметр должен появиться в запросе, запускающем сеанс SOAP. Если этот параметр появляется в любом запросе с заголовком sqloptions:sqlSession, который также не содержит атрибута initiate, формируется сообщение об ошибке.

Ниже приведен фрагмент схемы для параметра 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>

Примеры

Ниже приведены примеры использования заголовка sqloptions:applicationName внутри сообщений запроса и ответа SOAP.

Запрос

<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>

Ответ

<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>

См. также

Справочник