SPClaimProviderManager.GetUserIdentifierEncodedClaim method (String)

Extracts the EncodeClaim(SPClaim)-encoded SPClaim from the identity.

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

Syntax

'Declaration
Public Function GetUserIdentifierEncodedClaim ( _
    identityName As String _
) As String
'Usage
Dim instance As SPClaimProviderManager
Dim identityName As String
Dim returnValue As String

returnValue = instance.GetUserIdentifierEncodedClaim(identityName)
public string GetUserIdentifierEncodedClaim(
    string identityName
)

Parameters

  • identityName
    Type: System.String

    The [P:HYPERLINK"https://msdn.microsoft.com/en-us/library/system.security.principal.aspx"System.Security.Principal.IIdentity.Name] parameter to get the claim from.

Return value

Type: System.String
An EncodeClaim(SPClaim)-encoded SPClaim representing the identity parameter.

Exceptions

Exception Condition
ArgumentNullException

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

ArgumentException

The identity does not contain an encoded claim.

See also

Reference

SPClaimProviderManager class

SPClaimProviderManager members

GetUserIdentifierEncodedClaim overload

Microsoft.SharePoint.Administration.Claims namespace