Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function sets a store property.

Syntax

BOOL CertSetStoreProperty(
  HCERTSTORE 
hCertStore,
  DWORD 
dwPropId,
  DWORD 
dwFlags,
  const void* 
pvData
);

Parameters

hCertStore

[in] Handle to the certificate store.

dwPropId

[in] Specifies one of a range of store properties. Values for user-defined properties must be outside the current range of predefined context property values. Currently, user-defined pwPropIdvalues begin at 4,096. There is one predefined store property, CERT_STORE_LOCALIZED_NAME_PROP_ID, which is the localized name of the store.

dwFlags

[in] Reserved for future use and must be set to zero.

pvData

[in] Pointer to a CRYPT_DATA_BLOBstructure, if the value of the dwPropIdparameter is CERT_STORE_LOCALIZED_NAME_PROP_ID. The type definition for the pvDataparameter depends on the dwPropIdvalue. The pbDatamember of that structure is a pointer to a NULL-terminated Unicode character string. The cbDatamember of that structure is a DWORDvalue holding the length of the string.

For user-defined dwPropIdvalues, the pvDataparameter is a pointer to an encoded PCRYPT_DATA_BLOB.

If a value already exists for the selected property, the old value is replaced.

Calling this function with the pvDataparameter set to NULL deletes a property.

Return Value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE.

Remarks

Store property identifiers are properties applicable to an entire store. They are not properties for an individual certificate context. Currently, no store properties are persisted.

Requirements

Header wincrypt.h
Library crypt32.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also