Edit

Share via

ICertRequest2::GetCAProperty method (certcli.h)

  • Article

The GetCAProperty method retrieves a property value for the certification authority (CA). This method's functionality is identical to ICertAdmin2::GetCAProperty. For information about this method, see ICertAdmin2::GetCAProperty.

Syntax

HRESULT GetCAProperty(
  [in]          const BSTR strConfig,
  [in]          LONG       PropId,
  [in]          LONG       PropIndex,
  [in]          LONG       PropType,
  [in]          LONG       Flags,
  [out, retval] VARIANT    *pvarPropertyValue
);

Parameters

[in] strConfig

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.

[in] PropId

Specifies the property identifier. For information about this parameter, see the table in ICertAdmin2::GetCAProperty.

[in] PropIndex

If PropId is indexed, the zero-based index to use when retrieving the property value. If PropId is not indexed, this value is ignored.

[in] PropType

Specifies the type of the property, which corresponds to the Type column in the PropId table. The type can be one of the following types.

Value Meaning
PROPTYPE_LONG
 Signed long data
PROPTYPE_DATE
 Date/time (reserved for future use)
PROPTYPE_BINARY
 Binary data
PROPTYPE_STRING
 Unicode string data

[in] Flags

The following flags can be used to specify the format of the returned property value; these flags have meaning only for binary data (such as certificates, certificate chains, or certificate revocation lists) and is ignored otherwise.

Value Meaning
CV_OUT_BASE64
 BASE64 without BEGIN/END
CV_OUT_BASE64HEADER
 BASE64 with BEGIN CERTIFICATE and END CERTIFICATE
CV_OUT_BASE64REQUESTHEADER
 BASE64 with BEGIN NEW CERTIFICATE REQUEST and END NEW CERTIFICATE REQUEST
CV_OUT_BASE64X509CRLHEADER
 BASE64 with BEGIN X509 CRL and END X509 CRL
CV_OUT_BINARY
 Binary
CV_OUT_HEX
 Hexadecimal string
CV_OUT_HEXADDR
 Hexadecimal string with address/offset
CV_OUT_HEXASCII
 Hexadecimal string with ASCII
CV_OUT_HEXASCIIADDR
 Hexadecimal string with ASCII and address/offset

[out, retval] pvarPropertyValue

A pointer to a VARIANT that receives the requested property value.

When you have finished using the VARIANT, free it by calling the VariantClear function.

Return value

C++

If the method succeeds, the method returns S_OK.

If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

VB

The return value is a Variant that receives the requested property value.

Requirements

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

See also

CCertRequest

ICertRequest

ICertRequest2