CredentialId.CreateFriendlyPPID 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.]

Utility method to generate a user-friendly version of a PPID, as specified in Section 8.6.3 of Identity Selector Interoperability Profile V1.0.

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

Usage

'Usage
Dim rawPPID As String
Dim returnValue As String

returnValue = CredentialId.CreateFriendlyPPID(rawPPID)

Syntax

'Declaration
Public Shared Function CreateFriendlyPPID ( _
    rawPPID As String _
) As String

public static string CreateFriendlyPPID (
    string rawPPID
)

public:
static String^ CreateFriendlyPPID (
    String^ rawPPID
)

public static String CreateFriendlyPPID (
    String rawPPID
)

public static function CreateFriendlyPPID (
    rawPPID : String
) : String

Parameters

rawPPID
The raw PPID value encoded as a base64 string.

Return Value

A Friendly PPID string of the form "AAA-AAAA-AAA".

Exceptions

Exception type	Condition
ArgumentNullException	The input parameter 'rawPPID' is null.
InvalidOperationException	The input parameter 'rawPPID' is not a valid Base-64 encoded form.

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)