Edit

Share via

ICertAdmin2::GetConfigEntry method (certadm.h)

  • Article

The GetConfigEntry method retrieves configuration information for a certification authority (CA).

Syntax

HRESULT GetConfigEntry(
  [in]  const BSTR strConfig,
  [in]  const BSTR strNodePath,
  [in]  const BSTR strEntryName,
  [out] VARIANT    *pvarEntry
);

Parameters

[in] strConfig

String value that represents a valid configuration string for the CA in the form COMPUTERNAME\CANAME, where COMPUTERNAME is the Certificate Services server's network name, and CANAME is the common name of the CA, as entered during Certificate Services setup. For information about the configuration string name, see ICertConfig. This parameter can be an empty string, in which case the function retrieves configuration information that is not specific to a CA. This parameter cannot be NULL.

Important  GetConfigEntry does not clear the internal cache when the configuration string is changed. When you change the configuration string for the CA, you must instantiate a new ICertAdmin object and call this method again with the new configuration string.
 

[in] strNodePath

String value that represents the node path for the configuration information. This parameter can be an empty string, in which case the function retrieves configuration information from the path identified by strConfig. This parameter cannot be NULL.

[in] strEntryName

String value that represents the name of the entry whose information is being retrieved. This value can be an empty string, in which case all of the entry names are retrieved. This parameter cannot be NULL.

[out] pvarEntry

A pointer to a VARIANT that receives the requested information.

Return value

C++

If the function is successful, the return value is S_OK.

If the function fails, the return value is an HRESULT that indicates the error. For a list of common error codes, see Common HRESULT Values.

VB

The return value is a Variant that represents the retrieved configuration information.

Remarks

The configuration information is stored in the registry under the following path.

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\CertSvc\Configuration\[CASANITIZEDNAME]\[strNodePath]\[strEntryName]

Where CASANITIZEDNAME is the sanitized name for the CA. For more information about sanitized names, see ICertConfig2::GetConfig.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header certadm.h (include Certsrv.h)
Library Certidl.lib
DLL Certadm.dll

See also

ICertAdmin2