This documentation is archived and is not being maintained.

KeyInfoRetrievalMethod Class

References KeyInfo objects stored at a different location when using XMLDSIG or XML encryption.

System::Object
  System.Security.Cryptography.Xml::KeyInfoClause
    System.Security.Cryptography.Xml::KeyInfoRetrievalMethod

Namespace:  System.Security.Cryptography.Xml
Assembly:  System.Security (in System.Security.dll)

[HostProtectionAttribute(SecurityAction::LinkDemand, MayLeakOnAbort = true)]
public ref class KeyInfoRetrievalMethod : public KeyInfoClause

The KeyInfoRetrievalMethod type exposes the following members.

  NameDescription
Public methodKeyInfoRetrievalMethod()Initializes a new instance of the KeyInfoRetrievalMethod class.
Public methodKeyInfoRetrievalMethod(String)Initializes a new instance of the KeyInfoRetrievalMethod class with the specified Uniform Resource Identifier (URI) pointing to the referenced KeyInfo object.
Public methodKeyInfoRetrievalMethod(String, String)Initializes a new instance of the KeyInfoRetrievalMethod class with the specified Uniform Resource Identifier (URI) pointing to the referenced KeyInfo object and the URI that describes the type of data to retrieve.
Top

  NameDescription
Public propertyTypeGets or sets a Uniform Resource Identifier (URI) that describes the type of data to be retrieved.
Public propertyUriGets or sets the Uniform Resource Identifier (URI) of the KeyInfoRetrievalMethod object.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetXmlReturns the XML representation of the KeyInfoRetrievalMethod object. (Overrides KeyInfoClause::GetXml().)
Public methodLoadXmlParses the input XmlElement object and configures the internal state of the KeyInfoRetrievalMethod object to match. (Overrides KeyInfoClause::LoadXml(XmlElement).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The KeyInfoRetrievalMethod class represents the <RetrievalMethod> element for both XML encryption and XML digital signatures.

Use the KeyInfoRetrievalMethod class to reference the same KeyInfo information in multiple XMLDSIG signatures or encrypted XML documents, especially when the referenced information is large. For example, a <RetrievalMethod> subelement can be used to reference a KeyInfoX509Data object that contains an X.509v3 certificate chain, which validates the signing key.

For more information about the <RetrievalMethod> element, see Section 4.4.3 of the XMLDSIG specification, which is available from the World Wide Web Consortium (W3C) at www.w3.org/TR/xmldsig-core/, or see the XML Encryption specification, which is available from the W3C at www.w3.org/TR/xmlenc-core/.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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