CertRetrieveLogoOrBiometricInfo function

The CertRetrieveLogoOrBiometricInfo function performs a URL retrieval of logo or biometric information specified in either the szOID_LOGOTYPE_EXT or szOID_BIOMETRIC_EXT certificate extension. The szOID_BIOMETRIC_EXT extension (IETF RFC 3739) supports the addition of a signature or a pictorial representation of the human holder of the certificate. The szOID_LOGOTYPE_EXT extension (IETF RFC 3709) supports the addition of organizational pictorial representations in certificates.

Syntax

BOOL WINAPI CertRetrieveLogoOrBiometricInfo(
  _In_       PCCERT_CONTEXT pCertContext,
  _In_       LPCSTR         lpszLogoOrBiometricType,
  _In_       DWORD          dwRetrievalFlags,
  _In_       DWORD          dwTimeout,
  _In_       DWORD          dwFlags,
  _Reserved_ void           *pvReserved,
  _Out_      BYTE           **ppbData,
  _Out_      DWORD          *pcbData,
  _Out_      LPWSTR         *ppwszMimeType
);

Parameters

pCertContext [in]

The address of a CERT_CONTEXT structure that contains the certificate.

lpszLogoOrBiometricType [in]

The address of a null-terminated ANSI string that contains an object identifier (OID) string that identifies the type of information to retrieve.

This parameter may also contain one of the following predefined values.

Value	Meaning
CERT_RETRIEVE_ISSUER_LOGO	Retrieve the certificate issuer logotype.
CERT_RETRIEVE_SUBJECT_LOGO	Retrieve the certificate subject logotype.
CERT_RETRIEVE_COMMUNITY_LOGO	Retrieve the certificate community logotype.
CERT_RETRIEVE_BIOMETRIC_PICTURE_TYPE	Retrieve the picture associated with the certificate.
CERT_RETRIEVE_BIOMETRIC_SIGNATURE_TYPE	Retrieve the signature associated with the certificate.

 

dwRetrievalFlags [in]

A set of flags that specify how the information should be retrieved. This parameter is passed as the dwRetrievalFlags in the CryptRetrieveObjectByUrl function.

dwTimeout [in]

The maximum amount of time, in milliseconds, to wait for the retrieval.

dwFlags [in]

This parameter is not used and must be zero.

pvReserved

This parameter is not used and must be NULL.

ppbData [out]

The address of a BYTE pointer that receives the logotype or biometric data. This memory must be freed when it is no longer needed by passing this pointer to the CryptMemFree function.

pcbData [out]

The address of a DWORD variable that receives the number of bytes in the ppbData buffer.

ppwszMimeType [out]

The address of a pointer to a null-terminated Unicode string that receives the Multipurpose Internet Mail Extensions (MIME) type of the data. This parameter can be NULL if this information is not needed. This memory must be freed when it is no longer needed by passing this pointer to the CryptMemFree function.

This address always receives NULL for biometric types. You must always ensure that this parameter contains a valid memory address before attempting to access the memory.

Return value

Returns nonzero if successful or zero otherwise.

For extended error information, call GetLastError. Possible error codes returned by the GetLastError function include, but are not limited to, the following.

Requirements

See also

CryptMemFree