DSQUERYPARAMS structure (dsquery.h)

The DSQUERYPARAMS structure contains query data used by the directory service query when searching the directory service. This structure is provided by the CFSTR_DSQUERYPARAMS clipboard format by the IDataObject provided by the ICommonQuery::OpenQueryWindow method. The caller of ICommonQuery::OpenQueryWindow can use this to retrieve the filter, column data used by the result view when issuing a query against the server.

Syntax

typedef struct {
  DWORD     cbStruct;
  DWORD     dwFlags;
  HINSTANCE hInstance;
  LONG      offsetQuery;
  LONG      iColumns;
  DWORD     dwReserved;
  DSCOLUMN  aColumns[1];
} DSQUERYPARAMS, *LPDSQUERYPARAMS;

Members

cbStruct

Contains the size, in bytes, of the DSQUERYPARAMS structure. This member is used for versioning of the structure.

dwFlags

Reserved.

hInstance

Contains an instance handle used for extracting resources.

offsetQuery

Contains the offset, in bytes, from the address of this structure to a null-terminated Unicode string that contains the LDAP filter.

iColumns

Contains the number of elements in the aColumns array.

dwReserved

Reserved.

aColumns[1]

Contains an array of DSCOLUMN structures that contain the results of the query. The iColumns member specifies the number of elements in this array.

Requirements

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

See also

CFSTR_DSQUERYPARAMS

DSCOLUMN

Display Structures in Active Directory Domain Services

ICommonQuery::OpenQueryWindow