ADS_SEARCHPREF_INFO structure (iads.h)
The ADS_SEARCHPREF_INFO structure specifies the query preferences.
Syntax
typedef struct ads_searchpref_info {
ADS_SEARCHPREF dwSearchPref;
ADSVALUE vValue;
ADS_STATUS dwStatus;
} ADS_SEARCHPREF_INFO, *PADS_SEARCHPREF_INFO, *LPADS_SEARCHPREF_INFO;
Members
dwSearchPref
Contains one of the ADS_SEARCHPREF_ENUM enumeration values that specifies the search option to set.
vValue
Contains a ADSVALUE structure that specifies the data type and value of the search preference.
dwStatus
Receives one of the ADS_STATUSENUM enumeration values that indicates the status of the search preference. The IDirectorySearch::SetSearchPreference method will fill in this member when it is called.
Remarks
To setup a search preference, assign appropriate values to the fields of an ADS_SEARCHPREF_INFO structure passed to the server. The vValue member of the ADS_SEARCHPREF_INFO structure is an ADSVALUE structure. The following table lists the ADS_SEARCHPREF_ENUM values, the corresponding values for the dwType member of the ADSVALUE structure, and the ADSVALUE member that is used for the specified type.
ADS_SEARCHPREF_ENUM Value | dwType member of ADSVALUE | ADSVALUE member |
---|---|---|
ADS_SEARCHPREF_ASYNCHRONOUS | ADSTYPE_BOOLEAN | Boolean |
ADS_SEARCHPREF_DEREF_ALIASES | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_SIZE_LIMIT | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_TIME_LIMIT | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_ATTRIBTYPES_ONLY | ADSTYPE_BOOLEAN | Boolean |
ADS_SEARCHPREF_SEARCH_SCOPE | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_TIMEOUT | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_PAGESIZE | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_PAGED_TIME_LIMIT | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_CHASE_REFERRALS | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_SORT_ON | ADSTYPE_PROV_SPECIFIC | ProviderSpecific |
ADS_SEARCHPREF_CACHE_RESULTS | ADSTYPE_BOOLEAN | Boolean |
ADS_SEARCHPREF_DIRSYNC | ADSTYPE_PROV_SPECIFIC | ProviderSpecific |
ADS_SEARCHPREF_TOMBSTONE | ADSTYPE_BOOLEAN | Boolean |
ADS_SEARCHPREF_VLV | ADSTYPE_PROV_SPECIFIC | ProviderSpecific |
ADS_SEARCHPREF_ATTRIBUTE_QUERY | ADSTYPE_CASE_IGNORE_STRING | CaseIgnoreString |
ADS_SEARCHPREF_SECURITY_MASK | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_DIRSYNC_FLAG | ADSTYPE_INTEGER | Integer |
ADS_SEARCHPREF_EXTENDED_DN | ADSTYPE_INTEGER | Integer |
For more information and examples of how to use the ADS_SEARCHPREF_INFO structure, see the discussions of the IDirectorySearch::SetSearchPreference method and the ADS_SEARCHPREF_ENUM enumeration.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows Vista |
Minimum supported server | Windows Server 2008 |
Header | iads.h |