SecurityTokenReference.RelativeReference Property

Article
09/15/2006

Sets a reference to a security token elsewhere in the SOAP message.

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

Usage

'Usage
Dim securityTokenReference1 As SecurityTokenReference

Dim returnValue As String
returnValue = securityTokenReference1.RelativeReference

Dim sampleValue As String
securityTokenReference1.RelativeReference = sampleValue

Syntax

'Declaration
Public Property RelativeReference() As String

public string RelativeReference {get; set;}

public: property String^ RelativeReference{
    String^ get();
    Void set(String^);
}

public System.String get_RelativeReference();
public void set_RelativeReference(System.String);

public function get RelativeReference() : String;
public function set RelativeReference(String);

Property Value

A URI to a security token elsewhere in the SOAP message

Exceptions

Exception type	Condition
System.InvalidOperationException	RelativeReference is set when the Token property is not equal to null.

Remarks

When you set the RelativeReference property and then call the GetXml or GetInnerXml method, a <Reference> element is added to the <SecurityTokenReference> element. The URI attribute of the <Reference> element is set to the value of the RelativeReference property prefixed with a number sign (#).

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