CRUMB Argument

The crumb argument supports full Advanced Query Syntax (AQS) statements and is especially useful as a means of controlling the scope of a search. In addition to AQS statments, the crumb argument can take a special location parameter on Windows Vista and kind and store parameters on Windows XP, as described later in this topic.

This topic contains the following sections:

Crumb Syntax

The crumb syntax is as follows:


crumb=<column>:<value>[,<label>][,<column>:<value>[,<label>]]& 

The <column> portion is any property in the property system, and the <value> portion is a valid value for that property. The <label> portion is an optional alias for the property that displays as a user interface hint.

General Examples


crumb=System.Author:paolo&
crumb=store:mapi&
crumb=location:c%3a%5cMyVacationPix,Vacation&

Using crumb with Vista (location)

In the crumb parameter, Windows Vista supports full AQS and also the location property, which has a special implementation available only on Windows Vista. You can use either an AQS string or the location property within a single crumb parameter, but not both. If the crumb parameter includes AQS, everything else in that crumb parameter is ignored.

The location property enables you to specify a path to search. Windows Vista can bypass the Indexer and traverse the directory directly if the location is outside the Indexer's crawl scope. Consequently, these searches may be slower than searches that use the Indexer.

When you specify a location property, two additional parameters are supported and optional:

ParameterValuesDescription
inclusioninclude, excludeSpecifies whether the query should include or exclude items from that path. "Include" is the default. Windows Vista does not support exclusions without inclusions. (See example)
recursionrecursive, nonrecursiveSpecifies whether the search should recurse all subfolders starting from the value defined in the location:<value>. "Recursive" is the default.

 

To scope a search using the search: protocol, you have different options depending on the target of the scope.

Folder on a local machine:

  • Use AQS (crumb=folder:<URL-encoded path>)
  • Use location argument (crumb=location:<URL-encoded path>)

Folder on a remote machine/network:

  • Use location argument (crumb=location:<URL-encoded path>)

Folder accessed through a known Universal Naming Convention (UNC) protocol handler:

  • Use AQS (crumb=store:<UNC protocol handler name>)
  • Use location argument (crumb=location:<URL-encoded path>)

Vista Examples


search:query=vacation&crumb=location:shell%3aPersonal,include,recursive&
    
search:crumb=location:c%3a%5cPictures&crumb=location:c%3a%5cPictures%5cDuplicates,,exclude& 
    
search:crumb=location:c%3a%5cDocuments&crumb=kind:pics&

The first example executes a search for "vacation" starting at the shell://Personal location (a special shortcut to the user's My Documents folder), including that folder and all subfolders. See table below.

The second example executes a search within C:\Pictures, but not in C:\Pictures\Duplicates.

The third example executes a search within C:\Documents, limited to files with the kind property set to pics.

Constants for Common Folders

Windows Vista enables the use of CSIDL values that provide a unique system-independent way to identify special folders used frequently by applications, but which may not have the same name or location on any given system. For example, the system folder may be "C:\Windows" on one system and "C:\Winnt" on another.

Use these locations with this syntax:


crumb=location:shell%3a<LocationName>&

The following table lists the CSIDL values. Refer to ShellSpecialFolderConstants for more information.

Namesearch stringDescription
ADMINISTRATIVE TOOLSADMINISTRATIVE%20TOOLSFile system directory that serves as a repository for administrative tools.
APPDATAAPPDATAFile system directory that serves as a common repository for application-specific data. A typical path is C:\Documents and Settings\username\Application Data.
CACHECACHEFile system directory that serves as a common repository for temporary Internet files. A typical path is C:\Documents and Settings\username\Temporary Internet Files.
CD BURNINGCD%20BURNINGFolder containing data to be burned to CD.
COMMON ADMINISTRATIVE TOOLSCOMMON%20ADMINISTRATIVE%20TOOLSAdministrative tools for all users.
COMMON APPDATACOMMON%20APPDATAApplication data for all users. A typical path is C:\Documents and Settings\All Users\Application Data.
COMMON DESKTOPCOMMON DESKTOPMicrosoft Windows Desktop data for all users. Virtual folder that is the root of the namespace.
COMMON DOCUMENTSCOMMON%20DOCUMENTSDocuments for all users. A typical path is C:\Documents and Settings\All Users\My Documents.
COMMON PROGRAMSCOMMON%20PROGRAMSProgram groups common to all users. A typical path is C:\Documents and Settings\All Users\Start Menu\Programs.
COMMON START MENUCOMMON%20START%20MENUStart menu items common to all users. A typical path is C:\Documents and Settings\All Users\Start Menu.
COMMON STARTUPCOMMON%20STARTUPStartup program group common to all users.
COMMON TEMPLATESCOMMON%20TEMPLATESDocument templates common to all users.
COMMONMUSICMY%20MUSICMy Music folder templates common to all users.
COMMONPICTURESMY%20PICTURESMy Pictures folder templates common to all users.
COMMONVIDEOMY%20VIDEOMy Video folder templates common to all users.
CONNECTIONSFOLDERCONNECTIONSFOLDERfolder containing connection data.
CONTROL PANEL FOLDERCONTROLPANELFOLDERVirtual folder containing icons for the Control Panel applications.
COOKIESCOOKIESFile system directory that serves as a common repository for Internet cookies. A typical path is C:\Documents and Settings\username\Cookies.
DESKTOPDESKTOPMicrosoft Windows Desktop. Virtual folder that is the root of the namespace.
FAVORITESFAVORITESFile system directory that serves as a common repository for the user's favorite items. A typical path is C:\Documents and Settings\username\Favorites.
FONTSFONTSVirtual folder containing installed fonts. A typical path is C:\WINDOWS\Fonts.
HISTORYHISTORYFile system directory that serves as a common repository for Internet history items.
INTERNETFOLDERINTERNETFOLDERFolder that contains Internet data.
LOCAL APPDATALOCAL%20APPDATAFile system directory that serves as a data repository for local (non-roaming) applications. A typical path is C:\Documents and Settings\username\Local Settings\Application Data.
LOCALIZEDRESOURCEDIRLOCALIZEDRESOURCEDIRLocalized resource directory.
MYCOMPUTERFOLDERMYCOMPUTERFOLDERMy Computer. Virtual folder containing everything on the local computer: storage devices, printers, and Control Panel. This folder may also contain mapped network drives.
MY MUSICMY%20MUSICMy Music folder. A typical path is C:\Documents and Settings\username\My Documents\My Music.
MY PICTURESMY%20PICTURESMy Pictures folder. A typical path is C:\Documents and Settings\username\My Documents\My Pictures.
MY VIDEOMY%20VIDEOMy Video folder. A typical path is C:\Documents and Settings\username\My Documents\My Video.
NETHOODNETHOODVirtual folder representing the root of the network namespace hierarchy.
NETWORK PLACES FOLDERNETWORKDPLACESFOLDERA file system folder containing the link objects that may exist in the My Network Places virtual folder. It is not the same as NETHOOD, which represents the network namespace root.
OEM LINKSOEM%20LINKSFolder containing links to OEM sites.
PERSONALPERSONALFile system directory that serves as a common repository for a user's documents. A typical path is C:\Documents and Settings\username\My Documents.
PRINTERS FOLDERPRINTERS FOLDERVirtual folder containing installed printers.
PRINTHOODPRINTHOODFile system directory that contains the link objects that may exist in the Printers virtual folder. A typical path is C:\Documents and Settings\username\PrintHood.
PROGRAMSPROGRAMSFile system directory that contains the user's program groups (which are also file system directories). A typical path is C:\Documents and Settings\username\Start Menu\Programs.
PROFILEPROFILEUser's profile folder.
PROGRAM FILESPROGRAM%20FILESProgram Files folder. A typical path is C:\Program Files.
PROGRAM FILES COMMONPROGRAMFILESCOMMONProgram Files folder common to all users.
PROGRAM FILES COMMON x86PROGRAMFILESCOMMONX86Program Files folder common to all users on x86 machines.
PROGRAM FILESx86PROGRAMFILESx86Program Files folder on x86 machines.
RECENTRECENTFile system directory that contains the user's most recently used documents. A typical path is C:\Documents and Settings\username\Recent.
RECYCLE BIN FOLDERRECYCLEBINFOLDERVirtual folder containing the objects in the user's Recycle Bin.
RESOURCEDIRRESOURCEDIRThe Resource directory.
SENDTOSENDTOFile system directory that contains Send To menu items. A typical path is C:\Documents and Settings\username\SendTo.
START MENUSTART%20MENUFile system directory containing Start menu items. A typical path is C:\Documents and Settings\username\Start Menu.
STARTUPSTARTUPFile system directory that corresponds to the user's Startup program group.
SYSTEMx86SYSTEMx86System folder on x86 machines.
TEMPLATESTEMPLATESFile system directory that serves as a common repository for document templates.
SYSTEMSYSTEMSystem folder. A typical path is C:\Windows\System.
WINDOWSWINDOWSWindows directory or SYSROOT.

 

Argument Information

Minimum Operating SystemWindows Vista with Service Pack 1 (SP1)

 

 

 

Show: