Edit

Share via

IX509EnrollmentPolicyServer::GetUseClientId method (certenroll.h)

  • Article

The GetUseClientId method retrieves a value that specifies whether the ClientId attribute is set in the policy server flags of the certificate enrollment policy (CEP) server.

Syntax

HRESULT GetUseClientId(
  [out, retval] VARIANT_BOOL *pValue
);

Parameters

[out, retval] pValue

Pointer to a Boolean value that specifies whether the PsfUseClientId bit is set on the PolicyServerUrlFlags enumeration for this certificate enrollment policy (CEP) server.

Return value

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.

Return code Description
E_POINTER
 The pValue parameter cannot be NULL.

Remarks

This method returns VARIANT_TRUE if the PsfUseClientId bit is set on the PolicyServerUrlFlags enumeration for this CEP server. If this flag is set, the ClientID attribute is included in certificate requests during the enrollment process and can be used by the certification authority for diagnostic or auditing purposes. Examples of the type of information included in this attribute include the name of the cryptographic service provider, the Windows version number, the user name, the computer DNS name, and the domain controller DNS name.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header certenroll.h

See also

IX509EnrollmentPolicyServer