ICEnroll4::getCertFromFileResponse method (xenroll.h)

Article
02/22/2024

[This method is no longer available for use as of Windows Server 2008 and Windows Vista.]

The getCertFromFileResponse method retrieves the certificate from a file containing a response from a certification authority. This method was first defined in the ICEnroll4 interface.

Syntax

HRESULT getCertFromFileResponse(
  [in]  BSTR strResponseFileName,
  [out] BSTR *pstrCert
);

Parameters

[in] strResponseFileName

Specifies the name of the file that contains the response.

[out] pstrCert

A pointer to a BSTR value that receives the certificate retrieved from the response. When you have finished using the BSTR, free it by calling the SysFreeString function.

Return value

C++

If the method succeeds, the method returns S_OK.

If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

VB

The return value is a String that contains a certificate.

Remarks

The response contained in strResponseFileName must contain exactly one certificate; a child certificate cannot be present.

The response may be either a PKCS #7 or a full Certificate Management over CMS (CMC) response. However, to accept a full CMC response, the cryptographic service provider (CSP) must support Abstract Syntax Notation One (ASN.1) encoding of CMC structures.

When this method is called from script, the method displays a user interface that asks whether the user will allow a read operation from the file system.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	xenroll.h
Library	Uuid.lib
DLL	Xenroll.dll

Share via