SessionSecurityTokenCookieSerializer.GetUpn Method

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Returns a User Principal Name from a windows logon name.

Namespace: Microsoft.IdentityModel.Tokens
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim windowsLogonName As String
Dim returnValue As String

returnValue = Me.GetUpn(windowsLogonName)

Syntax

'Declaration
Protected Overridable Function GetUpn ( _
    windowsLogonName As String _
) As String

protected virtual string GetUpn (
    string windowsLogonName
)

protected:
virtual String^ GetUpn (
    String^ windowsLogonName
)

protected String GetUpn (
    String windowsLogonName
)

protected function GetUpn (
    windowsLogonName : String
) : String

Parameters

windowsLogonName
Name to translate into the UPN

Return Value

A User Principal Name of the form 'user@domain'

Exceptions

Exception type	Condition
ArgumentNullException	The input argument 'windowsLogonName' is null or empty.
InvalidOperationException	If 'windowsLogonName' is not of the form domain\\user or user@domain.

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

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

Share via