Share via

SecurityToken.GetXml Method

  • Article

When overridden in a derived class, generates an XML representation of the SecurityToken from the specified XML document.

Namespace: Microsoft.Web.Services3.Security.Tokens
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)

Usage

'Usage
Dim document As XmlDocument
Dim returnValue As XmlElement
Dim securityToken1 As SecurityToken
returnValue = securityToken1.GetXml(document)

Syntax

'Declaration
Public MustOverride Function GetXml( _
    ByVal document As XmlDocument _
) As XmlElement

public abstract XmlElement GetXml(
    XmlDocument document
);

public:
virtual XmlElement^ GetXml(
    XmlDocument^ document
) abstract;

public abstract XmlElement GetXml(
    XmlDocument document
);

public abstract function GetXml(
     document : XmlDocument
) : XmlElement;

Parameters

  • document
    An XmlDocument that the returned XmlElement will be added to eventually.

Return Value

An XmlElement that contains the token type.

Remarks

When building a SOAP message from XML elements returned from multiple objects that each have a GetXml method, use just one XmlDocument and pass it to each of the GetXml methods. This ensures that only one XmlDocument is loaded in memory for each SOAP message, instead of one for each object that implements the IXmlElement interface. This is because the GetXml method creates the returned XmlElement and sets its OwnerDocument property using the passed in XmlDocument .

Even though the OwnerDocument property is set to the passed in XmlDocument , the XmlElement is not added to the XmlDocument . To add the XmlElement to the XmlDocument , call the AppendChild method for the appropriate XmlNode in the System.Xml.XmlNode.ChildNodes collection.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server

Target Platforms

See Also

Reference

SecurityToken Class
SecurityToken Members
Microsoft.Web.Services3.Security.Tokens Namespace