ADSVALUE structure (iads.h)

The ADSVALUE structure contains a value specified as an ADSI data type. These data types can be ADSI Simple Data Types or ADSI-defined custom data types that include C-style structures.

The ADS_ATTR_INFO structure contains an array of ADSVALUE structures. Each ADSVALUE structure contains a single attribute value.

Syntax

typedef struct _adsvalue {
  ADSTYPE dwType;
  union {
    ADS_DN_STRING              DNString;
    ADS_CASE_EXACT_STRING      CaseExactString;
    ADS_CASE_IGNORE_STRING     CaseIgnoreString;
    ADS_PRINTABLE_STRING       PrintableString;
    ADS_NUMERIC_STRING         NumericString;
    ADS_BOOLEAN                Boolean;
    ADS_INTEGER                Integer;
    ADS_OCTET_STRING           OctetString;
    ADS_UTC_TIME               UTCTime;
    ADS_LARGE_INTEGER          LargeInteger;
    ADS_OBJECT_CLASS           ClassName;
    ADS_PROV_SPECIFIC          ProviderSpecific;
    PADS_CASEIGNORE_LIST       pCaseIgnoreList;
    PADS_OCTET_LIST            pOctetList;
    PADS_PATH                  pPath;
    PADS_POSTALADDRESS         pPostalAddress;
    ADS_TIMESTAMP              Timestamp;
    ADS_BACKLINK               BackLink;
    PADS_TYPEDNAME             pTypedName;
    ADS_HOLD                   Hold;
    PADS_NETADDRESS            pNetAddress;
    PADS_REPLICAPOINTER        pReplicaPointer;
    PADS_FAXNUMBER             pFaxNumber;
    ADS_EMAIL                  Email;
    ADS_NT_SECURITY_DESCRIPTOR SecurityDescriptor;
    PADS_DN_WITH_BINARY        pDNWithBinary;
    PADS_DN_WITH_STRING        pDNWithString;
  };
} ADSVALUE, *PADSVALUE, *LPADSVALUE;

Members

dwType

Data type used to interpret the union member of the structure. Values of this member are taken from the ADSTYPEENUM enumeration.

DNString

The null-terminated Unicode string that identifies the distinguished name (path) of a directory service object, as defined by ADS_DN_STRING, an ADSI simple data type.

CaseExactString

The null-terminated Unicode string to be interpreted case-sensitively, as defined by ADS_CASE_EXACT_STRING, an ADSI simple data type.

CaseIgnoreString

The null-terminated Unicode string to be interpreted without regard to case, as defined by ADS_CASE_IGNORE_STRING, an ADSI simple data type.

PrintableString

The null-terminated Unicode string that can be displayed or printed, as defined by ADS_PRINTABLE_STRING, an ADSI simple data type.

NumericString

The null-terminated Unicode string that contains numerals to be interpreted as text, as defined by ADS_NUMERIC_STRING, an ADSI simple data type.

Boolean

Boolean value, as defined by ADS_BOOLEAN, an ADSI simple data type.

Integer

Integer value, as defined by ADS_INTEGER, an ADSI simple data type.

OctetString

An octet string, as defined by ADS_OCTET_STRING, an ADSI-defined data type.

UTCTime

Time specified as Coordinated Universal Time (UTC), as defined by ADS_UTC_TIME, an ADSI simple data type.

LargeInteger

Long integer value, as defined by ADS_LARGE_INTEGER, an ADSI simple data type.

ClassName

Class name string, as defined by ADS_OBJECT_CLASS, an ADSI simple data type.

ProviderSpecific

Provider-specific structure, as defined by ADS_PROV_SPECIFIC, an ADSI-defined data type.

pCaseIgnoreList

Pointer to a ADS_CASEIGNORE_LIST, an ADSI-defined data type.

pOctetList

Pointer to a list of ADS_OCTET_LIST, an ADSI-defined data type.

pPath

Pointer to the ADS_PATH name, an ADSI-defined data type.

pPostalAddress

Pointer to the ADS_POSTALADDRESS data, an ADSI-defined data type.

Timestamp

Time stamp of the ADS_TIMESTAMP type, an ADSI-defined data type.

BackLink

A link of the ADS_BACKLINK type, an ADSI-defined data type.

pTypedName

Pointer to the ADS_TYPEDNAME name, an ADSI-defined data type.

Hold

A data structure of the ADS_HOLD type, an ADSI-defined data type.

pNetAddress

Pointer to the ADS_NETADDRESS data, an ADSI-defined data type.

pReplicaPointer

Pointer to a replica pointer of ADS_REPLICAPOINTER, an ADSI-defined data type.

pFaxNumber

Pointer to a facsimile number of ADS_FAXNUMBER, an ADSI-defined data type.

Email

Email address of a user of ADS_EMAIL, an ADSI-defined data type.

SecurityDescriptor

Windows security descriptor, as defined by ADS_NT_SECURITY_DESCRIPTOR, an ADSI-defined data type.

pDNWithBinary

Pointer to an ADS_DN_WITH_BINARY structure that maps a distinguished name of an object to its GUID value.

pDNWithString

Pointer to an ADS_DN_WITH_STRING structure that maps a distinguished name of an object to a nonvarying string value.

Remarks

Members of the ADSVALUE structure specify the data type of attributes. For more information and a code example, see ADS_ATTR_INFO.

Requirements

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

See also

ADSI Simple Data Types

ADSI Structures

ADSTYPEENUM

ADS_ATTR_INFO

ADS_BACKLINK

ADS_CASEIGNORE_LIST

ADS_DN_WITH_BINARY

ADS_DN_WITH_STRING

ADS_EMAIL

ADS_FAXNUMBER

ADS_HOLD

ADS_NETADDRESS

ADS_NT_SECURITY_DESCRIPTOR

ADS_OCTET_LIST

ADS_OCTET_STRING

ADS_PATH

ADS_POSTALADDRESS

ADS_PROV_SPECIFIC

ADS_REPLICAPOINTER

ADS_TIMESTAMP

ADS_TYPEDNAME

IDirectoryObject::CreateDSObject

IDirectoryObject::GetObjectAttributes

IDirectoryObject::SetObjectAttributes

IDirectorySearch::SetSearchPreference