sqloptions:applicationName (Header-Element)
Diese Funktion wird in zukünftigen Versionen von Microsoft SQL Server nicht mehr bereitgestellt. Verwenden Sie diese Funktion beim Entwickeln neuer Anwendungen nicht, und planen Sie das Ändern von Anwendungen, in denen es zurzeit verwendet wird.
Die Anmeldeoption sqloptions:applicationName ermöglicht dem Client das Angeben des Namens der für die Anmeldung verwendeten Anwendung. Beispiel:
<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>
Die Anmeldeoption sqloptions:applicationName wird als SOAP-Header angezeigt. Er besteht aus einem Element, das den Namen sqloptions:applicationName hat. Das Element verfügt über ein obligatorisches Attribut: value. Bei diesem Attribut handelt es sich um eine Zeichenfolge. Das value-Attribut gibt den "application name" an, die für die Anmeldung festgelegt werden soll. Diese Angabe finden Sie in der program_name-Spalte der Kompatibilitätssicht sys.sysprocesses.
In einer SOAP-Anforderung kann jeweils nur eine Instanz des optionalen sqloptions:hostName-Headers vorkommen. Dieser Header darf nicht in einer SOAP-Antwort enthalten sein. Mehrere Instanzen der Option verursachen einen Fehler.
Der Server kann evtl. den Bereich der erkannten Werte für den sqloptions:clientNetwordID-Wert einschränken. Wenn ein Client einen Wert außerhalb des zulässigen Bereichs übermittelt, wird der Wert vom Server in einer nicht definierten Weise einfach abgeschnitten.
Wenn SOAP-Sitzungen verwendet werden, muss diese Option in der Anforderung enthalten sein, die zur Initiierung einer SOAP-Sitzung verwendet wird. Wenn diese Option in einer Anforderung mit einem sqloptions:sqlSession-Header verwendet wird, die nicht außerdem das initiate-Attribut enthält, wird ein Fehler generiert.
Das folgende Beispiel ist ein Schemafragment für die Option 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>
Beispiele
Die folgenden Beispiele zeigen die Verwendung des sqloptions:applicationName-Headers in SOAP-Anforderungs- und Antwortnachrichten.
Anforderung
<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>
Antwort
<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>