IX509AttributeOSVersion::InitializeEncode method (certenroll.h)

The InitializeEncode method initializes the attribute from operating system version information.

Syntax

HRESULT InitializeEncode(
  [in, optional] BSTR strOSVersion
);

Parameters

[in, optional] strOSVersion

A BSTR variable that contains the version information. The format of the string is major.minor.build.platform. This parameter is optional. If you do not specify a string, this method calls the GetVersionEx function.

Return value

If the function succeeds, the function returns S_OK.

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

Remarks

The object identifier (OID) for this attribute is XCN_OID_OS_VERSION (1.3.6.1.4.1.311.13.2.3). For more information, see CERTENROLL_OBJECTID.

You must call either InitializeEncode or InitializeDecode before you can use an IX509AttributeOSVersion object. The two methods complement each other. The InitializeEncode method enables you to construct an encoded Abstract Syntax Notation One (ASN.1) structure from raw data, and the InitializeDecode method enables you to initialize raw data from an encoded ASN.1 structure. You can call the OSVersion property to retrieve the raw 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

IX509AttributeOSVersion