struct SearchInfo in module com::sun::star::ucb::

(Global Index)

Syntax

struct SearchInfo;

Description

information needed to (recursively) search an object.

Field Summary

Criteria the search criteria.

Recursion the mode of recursion to use.

IncludeBase whether to include the object itself in the search or only (some of) its sub-objects.

RespectFolderViewRestrictions whether to respect the "view restrictions" specified for the folders hierarchically contained within an object (e.g., only searches through subscribed folders).

RespectDocViewRestrictions whether to respect the "view restrictions" specified for the documents hierarchically contained within an object (e.g., only searches through marked documents).

FollowIndirections whether to follow indirections (link objects) and search through their respective targets also.

Field Details



Criteria

Syntax

sequence< com::sun::star::ucb::SearchCriterium > Criteria;

Description

the search criteria.


Recursion

Syntax

com::sun::star::ucb::SearchRecursion Recursion;

Description

the mode of recursion to use.


IncludeBase

Syntax

boolean IncludeBase;

Description

whether to include the object itself in the search or only (some of) its sub-objects.


RespectFolderViewRestrictions

Syntax

boolean RespectFolderViewRestrictions;

Description

whether to respect the "view restrictions" specified for the folders hierarchically contained within an object (e.g., only searches through subscribed folders).


RespectDocViewRestrictions

Syntax

boolean RespectDocViewRestrictions;

Description

whether to respect the "view restrictions" specified for the documents hierarchically contained within an object (e.g., only searches through marked documents).


FollowIndirections

Syntax

boolean FollowIndirections;

Description

whether to follow indirections (link objects) and search through their respective targets also.

Top of Page