Platform SDK: Active Directory, ADSI, and Directory Services

ADS_FORMAT_ENUM

The ADS_FORMAT_ENUM enumeration specifies the available pathname value types used by the IADsPathname::Retrieve method.

typedef enum ADS_FORMAT_ENUM {
  ADS_FORMAT_WINDOWS           = 1,
  ADS_FORMAT_WINDOWS_NO_SERVER = 2,
  ADS_FORMAT_WINDOWS_DN        = 3,
  ADS_FORMAT_WINDOWS_PARENT    = 4,
  ADS_FORMAT_X500              = 5,
  ADS_FORMAT_X500_NO_SERVER    = 6,
  ADS_FORMAT_X500_DN           = 7,
  ADS_FORMAT_X500_PARENT       = 8,
  ADS_FORMAT_SERVER            = 9,
  ADS_FORMAT_PROVIDER          = 10,
  ADS_FORMAT_LEAF              = 11,
  } ADS_FORMAT_ENUM;

Elements

ADS_FORMAT_WINDOWS
Returns the full path in windows format, for example, "LDAP://servername/o=internet/…/cn=bar".
ADS_FORMAT_WINDOWS_NO_SERVER
Returns Windows format without server, for example, "LDAP://o=internet/…/cn=bar".
ADS_FORMAT_WINDOWS_DN
Returns Windows format of the distinguished name only, for example, "o=internet/…/cn=bar".
ADS_FORMAT_WINDOWS_PARENT
Returns Windows format of Parent only, for example, "o=internet/…".
ADS_FORMAT_X500
Returns the full path in X.500 format, for example, "LDAP://servername/cn=bar, …, o=internet".
ADS_FORMAT_X500_NO_SERVER
Returns the path name without server in X.500 format, for example, "LDAP://cn=bar, …, o=internet".
ADS_FORMAT_X500_DN
Returns only the distinguished name in X.500 format. For example, "cn=bar,…,o=internet".
ADS_FORMAT_X500_PARENT
Returns only the parent in X.500 format, for example, "…,o=internet".
ADS_FORMAT_SERVER
Returns the server name, for example, "servername".
ADS_FORMAT_PROVIDER
Returns the name of the provider, for example, "LDAP".
ADS_FORMAT_NAMESPACE
The same as ADS_FORMAT_PROVIDER.
ADS_FORMAT_LEAF
Returns the name of the leaf, for example, "cn=bar".

Remarks

Note  Because VBScript cannot read information from a type library, VBScript applications do not understand the symbolic constants as defined above. You should use the numerical constants instead to set the appropriate flags in your VBScript applications. If you want to use the symbolic constants as a good programming practice, you should make explicit declarations of such constants, as done here, in your VBScript applications.

Requirements

  Windows NT/2000: Requires Windows 2000 (or Windows NT 4.0 with DSClient).
  Windows 95/98: Requires Windows 95 or later (with DSClient).
  Header: Declared in Iads.h.

See Also

ADSI Enumerations, IADsPathname::Retrieve