SecurityTokenReference.GetXml Method (XmlDocument)

Article
09/15/2006

Generates an XML representation of the SecurityTokenReference using the specified XML document.

Namespace: Microsoft.Web.Services2.Security
Assembly: Microsoft.Web.Services2 (in microsoft.web.services2.dll)

Usage

'Usage
Dim document As XmlDocument
Dim returnValue As XmlElement
Dim securityTokenReference1 As SecurityTokenReference
returnValue = securityTokenReference1.GetXml(document)

Syntax

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

public virtual XmlElement GetXml(
    XmlDocument document
);

public: XmlElement^ GetXml(
    XmlDocument^ document
);

public XmlElement GetXml(
    XmlDocument document
);

public function GetXml(
     document : XmlDocument
) : XmlElement;

Parameters

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

Return Value

An System.Xml.XmlElement that contains the security token reference.

Exceptions

Exception type	Condition
System.ArgumentNullException	document is null.

Remarks

When building a SOAP message from XML elements returned from multiple objects that each have a GetXml method, use just one System.Xml.XmlDocument and pass it to each of the GetXml methods. This ensures that only one System.Xml.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 System.Xml.XmlElement and sets its System.Xml.XmlElement.OwnerDocument property using the passed in System.Xml.XmlDocument.

Even though the System.Xml.XmlElement.OwnerDocument property is set to the passed in System.Xml.XmlDocument, the System.Xml.XmlElement is not added to the System.Xml.XmlDocument. To add the System.Xml.XmlElement to the System.Xml.XmlDocument, call the System.Xml.XmlNode.AppendChild(System.Xml.XmlNode) method for the appropriate System.Xml.XmlNode in the !:System.Xml.XmlElement.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 Longhorn, and Windows 2000

Target Platforms

Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server, Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, Pocket PC, Windows CE, Smart Phone

Share via