sqloptions:sqlSession Header Element

The sqloptions:sqlSession option enables the client to control the session for the request when it included and appears as a SOAP header.

The header is made up of one element, named sqloptions:sqlSession. The element has five optional attributes: initiate, terminate, sessionId, timeout, and transactionDescriptor. For more information about the use and behavior of individual attributes, see Working with SOAP Sessions.

Only one instance of the sqloptions:sqlSession option can appear in a request, or in a response. Multiple instances of the option will generate an error.

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

<xs:element name="sqlSession form="qualified">
    <xs:annotation>
        <xs:documentation>
            SQL Server SOAP Session
        </xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:attribute
          name="initiate"
          default="false"
          type="xs:boolean"
          form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    TRUE to request to start a new session
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute
          name="terminate"
          default="false"
          type="xs:boolean"
          form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    TRUE to request to terminate an existing session
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="sessionId" type="xs:base64Binary" form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    The ID of a session
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="timeout" type="xs:int" form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    The timeout in seconds before the session expires.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute
          name="transactionDescriptor"
          type="xs:base64Binary"
          form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    The descriptor of a transaction to enlist to.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
    </xs:complexType>
</xs:element>

See Also

Reference

SOAP Extension Headers

Help and Information

Getting SQL Server 2005 Assistance