Edit

IX509PolicyServerUrl::GetStringProperty method (certenroll.h)

  • Article

The GetStringProperty method retrieves the certificate enrollment policy (CEP) server ID or the display name of the CEP server.

Syntax

HRESULT GetStringProperty(
  [in]          PolicyServerUrlPropertyID propertyId,
  [out, retval] BSTR                      *ppValue
);

Parameters

[in] propertyId

A PolicyServerUrlPropertyID value that specifies the string to retrieve. This can be one of the following values.

Value Meaning
PsPolicyID
 Retrieve an ID string for the policy server.
PsFriendlyName
 Retrieve a display name for the policy server.

[out, retval] ppValue

Pointer to a BSTR variable that receives the property value.

Return value

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.

Return code Description
CERTSRV_E_PROPERTY_EMPTY
 The property value cannot be found.
E_POINTER
 The propertyId parameter cannot be NULL.
E_OUTOFMEMORY
 Memory could not be allocated for the return value.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header certenroll.h

See also

IX509PolicyServerUrl