Edit

Share via

DS_NAME_FORMAT enumeration (ntdsapi.h)

  • Article

The DS_NAME_FORMAT enumeration provides formats to use for input and output names for the DsCrackNames function.

Syntax

typedef enum {
  DS_UNKNOWN_NAME = 0,
  DS_FQDN_1779_NAME = 1,
  DS_NT4_ACCOUNT_NAME = 2,
  DS_DISPLAY_NAME = 3,
  DS_UNIQUE_ID_NAME = 6,
  DS_CANONICAL_NAME = 7,
  DS_USER_PRINCIPAL_NAME = 8,
  DS_CANONICAL_NAME_EX = 9,
  DS_SERVICE_PRINCIPAL_NAME = 10,
  DS_SID_OR_SID_HISTORY_NAME = 11,
  DS_DNS_DOMAIN_NAME = 12
} DS_NAME_FORMAT;

Constants

 
DS_UNKNOWN_NAME
Value: 0
Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible
formats. Only use this value if the input format is unknown.
DS_FQDN_1779_NAME
Value: 1
Indicates that the fully qualified distinguished name is used. For example:

CN=someone,OU=Users,DC=Engineering,DC=Fabrikam,DC=Com
DS_NT4_ACCOUNT_NAME
Value: 2
Indicates a Windows NT 4.0 account name. For example:

Engineering\someone

The domain-only version includes two trailing backslashes (\).
DS_DISPLAY_NAME
Value: 3
Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN).
DS_UNIQUE_ID_NAME
Value: 6
Indicates a GUID string that the IIDFromString function returns. For example:

{4fa050f0-f561-11cf-bdd9-00aa003a77b6}
DS_CANONICAL_NAME
Value: 7
Indicates a complete canonical name. For example:

engineering.fabrikam.com/software/someone

The domain-only version includes a trailing forward slash (/).
DS_USER_PRINCIPAL_NAME
Value: 8
Indicates that it is using the user principal name (UPN). For example:

someone@engineering.fabrikam.com
DS_CANONICAL_NAME_EX
Value: 9
This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example:

engineering.fabrikam.com/software\nsomeone
DS_SERVICE_PRINCIPAL_NAME
Value: 10
Indicates it is using a generalized service principal name. For example:

www/www.fabrikam.com@fabrikam.com
DS_SID_OR_SID_HISTORY_NAME
Value: 11
Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see
SID Strings. The following is an example of a SID string:

S-1-5-21-397955417-626881126-188441444-501
DS_DNS_DOMAIN_NAME
Value: 12
Not supported by the Directory Service (DS) APIs.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Header ntdsapi.h

See also

DsCrackNames

Enumerations in Active Directory Domain Services