ExecuteOperations.Enroll Method

Article
10/02/2012

Perform the enroll operation for both smart cards and software based profiles.

Namespace: Microsoft.Clm.Provision
Assembly: Microsoft.Clm.Provision (in Microsoft.Clm.Provision.dll)

Usage

'Usage
Dim requestUuid As Guid
Dim certificateRequests As ReadOnlyCollection(Of CertificateRequest)
Dim pfxPassword As String
Dim comment As String
Dim returnValue As ReadOnlyCollection(Of Certificate)

returnValue = ExecuteOperations.Enroll(requestUuid, certificateRequests, pfxPassword, comment)

Syntax

'Declaration
Public Shared Function Enroll ( _
    requestUuid As Guid, _
    certificateRequests As ReadOnlyCollection(Of CertificateRequest), _
    pfxPassword As String, _
    comment As String _
) As ReadOnlyCollection(Of Certificate)

public static ReadOnlyCollection<Certificate> Enroll (
    Guid requestUuid,
    ReadOnlyCollection<CertificateRequest> certificateRequests,
    string pfxPassword,
    string comment
)

public:
static ReadOnlyCollection<Certificate^>^ Enroll (
    Guid requestUuid, 
    ReadOnlyCollection<CertificateRequest^>^ certificateRequests, 
    String^ pfxPassword, 
    String^ comment
)

public static ReadOnlyCollection<Certificate> Enroll (
    Guid requestUuid, 
    ReadOnlyCollection<CertificateRequest> certificateRequests, 
    String pfxPassword, 
    String comment
)

public static function Enroll (
    requestUuid : Guid, 
    certificateRequests : ReadOnlyCollection<CertificateRequest>, 
    pfxPassword : String, 
    comment : String
) : ReadOnlyCollection<Certificate>

Parameters

requestUuid
A Guid object that identifies the FIM CM request for which to perform the enroll operation.

certificateRequests
A collection of CertificateRequest objects that are required to perform the enroll operation.

pfxPassword
A String object that contains a password to protect any Personal Information Exchange (PFX) results that are returned from the call.

comment
A String object that contains a comment to be recorded in the event history for the enroll operation.

Return Value

A read-only collection of Certificate objects that resulted from the enrollment operation.

Remarks

PFX format, also known as PKCS#12, is used to retrieve certificates generated on the server or external certificates that are obtained from enrollment. The Certificate object supports many formats of representing the certificate information including PKCS#7, PFX. This call requires the caller to perform the interaction with the smart card to write the returned certificate and possibly key data.

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

Share via