Export (0) Print
Expand All

sqloptions:clientNetworkID Header Element

The sqloptions:clientNetworkID login option enables the client to specify the client network ID for the login, for example:

<SOAP-ENV:Header
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:sqloptions="http://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
    <sqloptions:clientNetworkID SOAP-ENV:mustUnderstand="1" value="networkID" />
    
</SOAP-ENV:Header>

The sqloptions:clientNetworkID login option appears as a SOAP header. It is made up of one element, named sqloptions:clientNetworkID. The element has one attribute, value, a base64-encoded binary value. This gives the client network ID to set for the login. This appears in the net_address column of the sys.sysprocesses compatibility view.

Only one instance of the sqloptions:clientNetworkID option can appear in a request. This header cannot appear in a response. Multiple instances of the option will generate an error.

The server might limit the range of the recognized values of the sqloptions:clientNetworkID value. If a client submits a value outside the allowed range, the server will silently truncate the value in an undefined manner.

If SOAP sessions are being used, this option must appear in the same request as the sqloptions:sqlsession initiate attribute. If this option appears in any request with a sqloptions:sqlSession header that does not also contain an initiate attribute, an error is generated.

The following is a schema fragment for the sqloptions:clientNetworkID option:

<xs:element name="clientNetworkID"  form="qualified">
    <xs:annotation>
        <xs:documentation>
            Set the client network ID for the login.
        </xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:attribute
          use="required"
          name="value"
          type="xs:base64Binary"
          form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    The client network ID to set for the login.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
    </xs:complexType>
</xs:element>

The following are examples of using the sqloptions:clientNetworkID header within SOAP request and response messages.

Request

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:sql="http://schemas.microsoft.com/sqlserver/2004/SOAP"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:sqlparam="http://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlParameter"
                   xmlns:sqlsoaptypes="http://schemas.microsoft.com/sqlserver/2004/SOAP/types"
                   xmlns:sqloptions="http://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
  <SOAP-ENV:Header>
    <sqloptions:clientNetworkID SOAP-ENV:mustUnderstand="1" value="AAAAADreaLE=" />
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <sql:sqlbatch>
      <sql:BatchCommands>
        SELECT TOP 1 net_address FROM sysprocesses WHERE spid=@@spid
      </sql:BatchCommands>
    </sql:sqlbatch>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<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="http://schemas.xmlsoap.org/soap/envelope/" 
                   xmlns:sql="http://schemas.microsoft.com/sqlserver/2004/SOAP" 
                   xmlns:sqlsoaptypes="http://schemas.microsoft.com/sqlserver/2004/SOAP/types" 
                   xmlns:sqlrowcount="http://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlRowCount" 
                   xmlns:sqlmessage="http://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlMessage" 
                   xmlns:sqlresultstream="http://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlResultStream" 
                   xmlns:sqltransaction="http://schemas.microsoft.com/sqlserver/2004/SOAP/types/SqlTransaction" 
                   xmlns:sqltypes="http://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>
                <net_address>value specified in the request</net_address>
              </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>

Community Additions

ADD
Show:
© 2014 Microsoft