SPSystemClaimProvider.CreateFarmClaim method

  • Article

Creates an SPClaim object that represents the SPFarm object.

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

Syntax

'Declaration
Public Shared Function CreateFarmClaim ( _
    farmID As Guid _
) As SPClaim
'Usage
Dim farmID As Guid
Dim returnValue As SPClaim

returnValue = SPSystemClaimProvider.CreateFarmClaim(farmID)

public static SPClaim CreateFarmClaim(
    Guid farmID
)

Parameters

  • farmID
    Type: System.Guid

    A GUID that represents the identity of the farm.

Return value

Type: Microsoft.SharePoint.Administration.Claims.SPClaim
An object that contains the SPClaimobject that is valid for the SPFarm represented by farmID.

Exceptions

Exception Condition
ArgumentNullException

The farmID parameter is a null reference (Nothing in Visual Basic).
ArgumentException

The farmID parameter contains characters that are invalid XML or are control characters.

See also

Reference

SPSystemClaimProvider class

SPSystemClaimProvider members

Microsoft.SharePoint.Administration.Claims namespace