Creates a new FIM CM retire request for a smart card.
Namespace: Microsoft.Clm.Provision
Assembly: Microsoft.Clm.Provision (in microsoft.clm.provision.dll)

Usage

Visual Basic 
Dim smartcard As Smartcard
Dim dataCollection As DataCollection
Dim comment As String
Dim priority As Byte
Dim returnValue As Request

returnValue = RequestOperations.InitiateRetire(smartcard, dataCollection, comment, priority)

Syntax

Visual Basic 
Public Shared Function InitiateRetire ( _
		smartcard As Smartcard, _
		dataCollection As DataCollection, _
		comment As String, _
		priority As Byte _
) As Request
C# 
public static Request InitiateRetire (
		Smartcard smartcard,
		DataCollection dataCollection,
		string comment,
		byte priority
)
C++ 
public:
static Request^ InitiateRetire (
		Smartcard^ smartcard, 
		DataCollection^ dataCollection, 
		String^ comment, 
		unsigned char priority
)
J# 
public static Request InitiateRetire (
		Smartcard smartcard, 
		DataCollection dataCollection, 
		String comment, 
		byte priority
)
JScript 
public static function InitiateRetire (
		smartcard : Smartcard, 
		dataCollection : DataCollection, 
		comment : String, 
		priority : byte
) : Request

Parameters

smartcard

A Smartcard object that describes the smart card to be discontinued.

dataCollection

A DataCollection object that contains all manager DataCollectionItem objects. This parameter must not be Null.

comment

A String object that contains a comment to be included in the history of the FIM CM request. Set this parameter to Null for no comment.

priority

The priority of the FIM CM request.

Return Value

A Request object for the new FIM CM retire request for the smart card.

Remarks

The following permissions are checked when this method is called:

  • The current user must have FIM CM Request Revoke permissions on the target user.

  • The current user must have Read permissions on the profile template.

  • The current user must be a FIM CM manager with Read and FIM CM Request Revoke permissions on the service connection point.

  • The current user must be listed as an Initiator on the Retire policy.


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

Development Platforms

Windows 2008 x64 Edition

Target Platforms

Windows XP SP3, Windows Vista SP1+, Windows 7, Windows Server 2008, Windows Server 2008 R2

See Also