ICustomUserPinGenerator.GenerateUserPin Method

Generates custom user PINs for smart cards.

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

Usage

'Usage
Dim instance As ICustomUserPinGenerator
Dim scUuid As Guid
Dim bHandled As Boolean
Dim returnValue As String

returnValue = instance.GenerateUserPin(scUuid, bHandled)

Syntax

'Declaration
Function GenerateUserPin ( _
    scUuid As Guid, _
    ByRef bHandled As Boolean _
) As String
string GenerateUserPin (
    Guid scUuid,
    ref bool bHandled
)
String^ GenerateUserPin (
    Guid scUuid, 
    bool% bHandled
)
String GenerateUserPin (
    Guid scUuid, 
    /** @ref */ boolean bHandled
)

Parameters

  • scUuid
    A Guid object that contains the identifier of the smart card.
  • bHandled
    true if the custom user PIN generator successfully handled the request to generate the user PIN for the smart card; otherwise, false.

Return Value

A String object that contains the custom user PIN for the smart card.

Remarks

If the custom user PIN generator successfully handled the request to generate the user PIN for the smart card, this method sets the bHandled parameter to true and returns the custom user PIN. This indicates to the FIM CM server that the returned PIN is valid and can be used as the user PIN for the smart card.

If, however, the custom user PIN generator did not successfully handle the request to generate the user PIN for the smart card, this method must set the bHandled parameter to false. This indicates to the FIM CM server that it should ignore the returned user PIN and instead call the default PIN generator built into FIM CM to generate the user PIN for the smart card.

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

Reference

ICustomUserPinGenerator Interface
ICustomUserPinGenerator Members
Microsoft.Clm Namespace