CertAddCertificateContextToStore

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function adds a certificate context to the certificate store.

Syntax

BOOL WINAPI CertAddCertificateContextToStore(
  HCERTSTORE hCertStore,
  PCCERT_CONTEXT pCertContext,
  DWORD dwAddDisposition,
  PCCERT_CONTEXT* ppStoreContext
);

Parameters

• hCertStore
  [in] Handle to a certificate store.

• pCertContext
  [in] Pointer to the CERT_CONTEXT structure to be added to the store.

• dwAddDisposition
  [in] Specifies the action to take if a matching certificate or a link to a matching certificate already exists in the store. The following table shows the currently defined disposition values and their uses.

  Value	Description
  CERT_STORE_ADD_ALWAYS	The function makes no check for an existing matching certificate or link to a matching certificate. A new certificate is always added to the store. This can lead to duplicates in a store.
  CERT_STORE_ADD_NEW	If a matching certificate or a link to a matching certificate exists, the operation fails. The GetLastError function returns the CRYPT_E_EXISTS code.
  CERT_STORE_ADD_NEWER	If a matching certificate or a link to a matching certificate exists, the function compares the NotBefore times on the certificates. If the existing certificate has a NotBefore time less than the NotBefore time on the new certificate, the old certificate or link is replaced just as with CERT_STORE_ADD_REPLACE_EXISTING. If the existing certificate has a NotBefore time greater than or equal to the NotBefore time on the certificate to be added, the function fails with the GetLastError function returning the CRYPT_E_EXISTS code. If a matching certificate or a link to a matching certificate is not found in the store, a new certificate is added to the store.
  CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES	The action is the same as for CERT_STORE_ADD_NEWER. However, if an older certificate is replaced, the properties of the older certificate are incorporated into the replacement certificate.
  CERT_STORE_ADD_REPLACE_EXISTING	If a link to a matching certificate exists, that existing certificate or link is deleted and a new certificate is created and added to the store. If a matching certificate or a link to a matching certificate does not exist, a new link is added.
  CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES	If a matching certificate exists in the store, the existing context is deleted before creating and adding the new context. The new added context inherits properties from the existing certificate.
  CERT_STORE_ADD_USE_EXISTING	If a matching certificate or a link to a matching certificate exists, that existing certificate or link is used and properties from the new certificate are added. The function does not fail, but it does not add a new context. If ppCertContext is not NULL, the existing context is duplicated. If a matching certificate or a link to a matching certificate does not exist, a new certificate is added.

• ppStoreContext
  [out] Optional. Pointer to a pointer to the copy to be made of the certificate that was added to the store.

  This parameter can be NULL, indicating that the calling application does not require a copy of the added certificate. If a copy is made, it must be freed by using the CertFreeCertificateContext function.

Return Value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE.

For extended error information, call the GetLastError function. The following table shows some possible error codes.

Errors from the called functions, CertAddEncodedCertificateToStore and CertSetCertificateContextProperty, can be propagated to this function.

Remarks

The certificate context is not duplicated using the CertDuplicateCertificateContext function. Instead, the function creates a new copy of the context and adds it to the store.

In addition to the encoded certificate, the CertDuplicateCertContext function also copies the context's properties, with the exception of the CERT_KEY_PROV_HANDLE_PROP_ID and CERT_KEY_CONTEXT_PROP_ID properties.

Requirements

See Also

Reference

CertAddEncodedCertificateToStore
CertDuplicateCertificateContext
CertFreeCertificateContext
CertSetCertificateContextProperty
CERT_CONTEXT