DS_SELECTION structure (objsel.h)

The DS_SELECTION structure contains data about an object the user selected from an object picker dialog box. The DS_SELECTION_LIST structure contains an array of DS_SELECTION structures.

Syntax

typedef struct _DS_SELECTION {
  PWSTR   pwzName;
  PWSTR   pwzADsPath;
  PWSTR   pwzClass;
  PWSTR   pwzUPN;
  VARIANT *pvarFetchedAttributes;
  ULONG   flScopeType;
} DS_SELECTION, *PDS_SELECTION;

Members

pwzName

Pointer to a null-terminated Unicode string that contains the object's relative distinguished name (RDN).

pwzADsPath

Pointer to a null-terminated Unicode string that contains the object's ADsPath. The format of this string depends on the flags specified in the flScope member of the DSOP_SCOPE_INIT_INFO structure for the scope from which this object was selected.

pwzClass

Pointer to a null-terminated Unicode string that contains the value of the object's objectClass attribute.

pwzUPN

Pointer to a null-terminated Unicode string that contains the object's userPrincipalName attribute value. If the object does not have a userPrincipalName value, pwzUPN points to an empty string (L"").

pvarFetchedAttributes

Pointer to an array of VARIANT structures. Each VARIANT contains the value of an attribute of the selected object. The attributes retrieved are determined by the attribute names specified in the apwzAttributeNames member of the DSOP_INIT_INFO structure passed to the IDsObjectPicker::Initialize method. The order of attributes in the pvarFetchedAttributes array corresponds to the order of attribute names specified in the apwzAttributeNames array.

The object picker dialog box may not be able to retrieve the requested attributes. If the attribute cannot be retrieved, the vt member of the VARIANT structure contains VT_EMPTY.

flScopeType

Contains one, or more, of the DSOP_SCOPE_TYPE_ that indicate the type of scope from which this object was selected. For more information, and a list of DSOP_SCOPE_TYPE_ flags, see the flType member of the DSOP_SCOPE_INIT_INFO structure.

Requirements

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

See also

DSOP_INIT_INFO

DSOP_SCOPE_INIT_INFO

DS_SELECTION_LIST

Directory Object Picker

IDsObjectPicker::Initialize

VARIANT