IAlternativeName::InitializeFromString method (certenroll.h)
The InitializeFromString method initializes the object from a string that contains an email address, a Domain Name System (DNS) name, a URL, a registered object identifier (OID), or a user principal name (UPN).
Syntax
HRESULT InitializeFromString(
[in] AlternativeNameType Type,
[in] BSTR strValue
);
Parameters
[in] Type
An AlternativeNameType enumeration value that identifies the type of name represented by the input string contained in the strValue parameter. This must be one of the following values.
[in] strValue
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. For a list of common error codes, see Common HRESULT Values.
Remarks
If you use this method to specify a UPN, the UPN is associated with the XCN_OID_NT_PRINCIPAL_NAME (1.3.6.1.4.1.311.20.2.3) OID and is Distinguished Encoding Rules (DER) encoded. You can call the RawData property to retrieve the encoded byte array. You can retrieve the OID by calling the ObjectId property.
If you use this method to specify any of the following name types, the method returns E_INVALIDARG.
Value | Description |
---|---|
XCN_CERT_ALT_NAME_UNKNOWN | The name type is not identified. |
XCN_CERT_ALT_NAME_OTHER_NAME | The name consists of an OID and a byte array. |
XCN_CERT_ALT_NAME_DIRECTORY_NAME | The name is an X.500 directory name. |
XCN_CERT_ALT_NAME_IP_ADDRESS | The name is an IP address. |
XCN_CERT_ALT_NAME_GUID | The name is a GUID. |
You can use the InitializeFromOtherName method to specify an OID and a corresponding name string, and you can use the InitializeFromRawData method to specify a GUID, IP address, or X.500 directory name.
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 |