Skip to content

Latest commit

 

History

History
130 lines (102 loc) · 4.96 KB

nf-casetup-icertsrvsetup-setcadistinguishedname.md

File metadata and controls

130 lines (102 loc) · 4.96 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:casetup.ICertSrvSetup.SetCADistinguishedName
ICertSrvSetup::SetCADistinguishedName (casetup.h)
Sets a certification authority (CA) common name and an optional distinguished name suffix.
ICertSrvSetup interface [Security]
SetCADistinguishedName method
ICertSrvSetup.SetCADistinguishedName
ICertSrvSetup::SetCADistinguishedName
SetCADistinguishedName
SetCADistinguishedName method [Security]
SetCADistinguishedName method [Security]
ICertSrvSetup interface
casetup/ICertSrvSetup::SetCADistinguishedName
security.icertsrvsetup_setcadistinguishedname
security\icertsrvsetup_setcadistinguishedname.htm
security
d513d4fd-abc7-44e6-822e-955de8613d55
12/05/2018
ICertSrvSetup interface [Security],SetCADistinguishedName method, ICertSrvSetup.SetCADistinguishedName, ICertSrvSetup::SetCADistinguishedName, SetCADistinguishedName, SetCADistinguishedName method [Security], SetCADistinguishedName method [Security],ICertSrvSetup interface, casetup/ICertSrvSetup::SetCADistinguishedName, security.icertsrvsetup_setcadistinguishedname
casetup.h
Windows
None supported
Windows Server 2008 [desktop apps only]
Casetup.idl
Certocm.dll
Windows
19H1
ICertSrvSetup::SetCADistinguishedName
casetup/ICertSrvSetup::SetCADistinguishedName
c++
APIRef
kbSyntax
COM
Certocm.dll
ICertSrvSetup.SetCADistinguishedName

ICertSrvSetup::SetCADistinguishedName

-description

The SetCADistinguishedName method sets a certification authority (CA) common name and an optional distinguished name suffix.

-parameters

-param bstrCADN [in]

A string that contains the name for a CA in the form CommonName,DistinguishedNameSuffix, where the comma (,) and DistinguishedNameSuffix are optional.

The following table describes an example of a distinguished name, including the optional distinguished name suffix, for the computer MyServer.

Value Meaning
CN=mydomain-MyServer-CA
Common name for the MyServer computer that belongs to the MyDomain domain.
DC=MyDomain,DC=MyCompany,DC=com
Distinguished name suffix (optional)
CN=MyDomain-MyServer-CA,DC=MyDomain,DC=MyCompany,DC=com
Distinguished name including the optional suffix

-param bIgnoreUnicode [in]

A value that indicates whether to allow Unicode encoding of the name information. A value of VARIANT_TRUE enables Unicode encoding.

-param bOverwriteExistingKey [in]

A value that indicates whether to allow the name in bstrCADN, even though a private key with the same name exists on the computer. A value of VARIANT_TRUE enables the method to overwrite the existing key.

-param bOverwriteExistingCAInDS [in]

A value that indicates whether to allow the name in bstrCADN, even though a CA with the same distinguished name exists in the directory service. A value of VARIANT_TRUE enables the method to overwrite the existing directory service entry.

-remarks

Upon success, the SetCADistinguishedName method changes the ENUM_SETUPPROP_CANAME and ENUM_SETUPPROP_CADSSUFFIX property values to reflect the bstrCADN name. For more information about setup properties, see CASetupProperty.

Upon failure, the SetCADistinguishedName method might set additional error information in the CAErrorId and CAErrorString properties.

If an existing key and its associated certificate are being used to configure the CA, this method must not be called. If an existing key is being used to configure the CA, without using the associated certificate, the common name in bstrCADN must match the sanitized ContainerName of the key.

If bstrCADN includes UTF8 encoding, set the appropriate flag in CAPolicy.inf and place it in the %windir%.

-see-also

ICertSrvSetup