CertEnumPhysicalStore function (wincrypt.h)

Article
10/13/2021

The CertEnumPhysicalStore function retrieves the physical stores on a computer. The function calls the provided callback function for each physical store found.

Syntax

BOOL CertEnumPhysicalStore(
  [in] const void                   *pvSystemStore,
  [in] DWORD                        dwFlags,
  [in] void                         *pvArg,
  [in] PFN_CERT_ENUM_PHYSICAL_STORE pfnEnum
);

Parameters

[in] pvSystemStore

If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvSystemStore points to a CERT_SYSTEM_STORE_RELOCATE_PARA structure that indicates both the name and the location of the system store to be enumerated. Otherwise, pvSystemStore is a pointer to a Unicode string that names the system store whose physical stores are to be enumerated. For information about prefixing a ServiceName or ComputerName to the system store name, see CertRegisterSystemStore.

[in] dwFlags

Specifies the location of the system store. The following flag values are defined:

CERT_SYSTEM_STORE_CURRENT_USER
CERT_SYSTEM_STORE_CURRENT_SERVICE
CERT_SYSTEM_STORE_LOCAL_MACHINE
CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY
CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY
CERT_SYSTEM_STORE_SERVICES
CERT_SYSTEM_STORE_USERS
CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE

In addition, CERT_SYSTEM_STORE_RELOCATE_FLAG or CERT_PHYSICAL_STORE_PREDEFINED_ENUM_FLAG can be combined using a bitwise-OR operation with any of the high-word location flags.

[in] pvArg

A pointer to a void that allows the application to declare, define, and initialize a structure to hold any information to be passed to the callback enumeration function.

[in] pfnEnum

A pointer to the callback function used to show the details for each physical store. This callback function determines the content and format for the presentation of information on each physical store. The application must provide the CertEnumPhysicalStoreCallback callback function.

Return value

If the function succeeds and another physical store was found, the return value is TRUE.

If the system store location only supports system stores and does not support physical stores, the function returns FALSE and GetLastError returns the ERROR_NOT_SUPPORTED code.

If the function fails and another physical store was not found, the return value is FALSE. For extended error information, call GetLastError.

Remarks

To use CertEnumPhysicalStore, an application must declare and define the ENUM_ARG structure and an enumeration callback function.

Examples

See Example C Program: Listing System and Physical Stores.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2003 [desktop apps \| UWP apps]
Target Platform	Windows
Header	wincrypt.h
Library	Crypt32.lib
DLL	Crypt32.dll

Share via