SPClaimProviderManager.ConvertClaimToIdentifier Method

  • Article

Converts an identity claim into its original unique identifier.

Namespace:  Microsoft.SharePoint.Administration.Claims
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Function ConvertClaimToIdentifier ( _
    encodedClaim As String _
) As String
'Usage
Dim instance As SPClaimProviderManager
Dim encodedClaim As String
Dim returnValue As String

returnValue = instance.ConvertClaimToIdentifier(encodedClaim)

public string ConvertClaimToIdentifier(
    string encodedClaim
)

Parameters

Return Value

Type: System.String
A string that contains the Identifier for the claim.

Exceptions

Exception Condition
ArgumentNullException

The encodedClaim parameter is empty or a null reference (Nothing in Visual Basic).
ArgumentException

The encodedClaim parameter does not represent a valid identifier.

Remarks

For example, given a Windows user encoded claim, this method will return a string in the DOMAIN\USERNAME format.

See Also

Reference

SPClaimProviderManager Class

SPClaimProviderManager Members

Microsoft.SharePoint.Administration.Claims Namespace