Partager via

BinarySecurityToken.GetXml Method (XmlDocument)

  • Article

Generates an XML representation of the BinarySecurityToken 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 binarySecurityToken1 As BinarySecurityToken
returnValue = binarySecurityToken1.GetXml(document)

Syntax

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

public override XmlElement GetXml(
    XmlDocument document
);

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

public override XmlElement GetXml(
    XmlDocument document
);

public override 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.

Exceptions

Exception type Condition
Exception

document is null.
SecurityFormatException

The namespace of the ValueType property is null, or of zero length.

-or-

The namespace of the EncodingType property is not WS-Security or the encoding type is not Base64Binary.

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

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