Edit

Share via

IX509ExtensionTemplateName::InitializeEncode method (certenroll.h)

  • Article

The InitializeEncode method initializes the extension from a string that contains the template name. This method is web enabled.

Syntax

HRESULT InitializeEncode(
  [in] BSTR strTemplateName
);

Parameters

[in] strTemplateName

A BSTR variable that contains the name.

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/value Description
HRESULT_FROM_WIN32(ERROR_ALREADY_INITIALIZED)
 The object is already initialized.

Remarks

You must call either InitializeEncode or InitializeDecode before you can use an IX509ExtensionTemplateName object. The two methods complement each other. The InitializeEncode method enables you to construct a Distinguished Encoding Rules (DER) encoded Abstract Syntax Notation One (ASN.1) extension object from raw data, and the InitializeDecode method enables you to initialize the raw data from an encoded object.

You can retrieve the following properties for this extension:

  • The Critical property identifies whether the extension is critical. You can also specify this property.
  • The ObjectId property retrieves the object identifier (OID).
  • The TemplateName property retrieves the template name (the raw extension data).

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header certenroll.h
DLL CertEnroll.dll

See also

IX509ExtensionTemplateName