Platforms to show: All Mac Windows Linux Cross-Platform

Back to CatSearchMBS class.

CatSearchMBS.BackupDateEnd as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin 3.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The end of the backup date search range.

This value is an unsigned integer. If you assign a double from a date totalseconds property, please move it to the matching range like in the example project "Find stuff from today".
(Read and Write property)

CatSearchMBS.BackupDateStart as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin 3.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The start of the backup date search range.

This value is an unsigned integer. If you assign a double from a date totalseconds property, please move it to the matching range like in the example project "Find stuff from today".
(Read and Write property)

CatSearchMBS.CreationDateEnd as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin 3.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The end of the creation date search range.

This value is an unsigned integer. If you assign a double from a date totalseconds property, please move it to the matching range like in the example project "Find stuff from today".
(Read and Write property)

CatSearchMBS.CreationDateStart as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin 3.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The start of the creation date search range.

This value is an unsigned integer. If you assign a double from a date totalseconds property, please move it to the matching range like in the example project "Find stuff from today".
(Read and Write property)

CatSearchMBS.creator as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All

dim c as CatSearchMBS
c.Creator="ttxt"
' will look for files created by the SimpleText application.

The above Creator property allows you to specifiy the search criteria. Without setting any property from this class, a search will find nothing.

Note: If you set one of this properties, all criterias must match to get a match back from a call to SearchNext.
(Read and Write property)

CatSearchMBS.FileFlags as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The file flags to search for.
Example
dim c as CatSearchMBS
c.FileFlags=&H4000 // Invisible
c.FileFlagsMask=&H4000 // only look on the invisible flag

The above FileFlags property allows you to specifiy the search criteria. Without setting any property from this class, a search will find nothing.

Note: If you set one of this properties, all criterias must match to get a match back from a call to SearchNext.

There is a FileFlags and a FileFlagsMask property which must be used together: bits set in FileFlagsMask specifiy which bits of FileFlags shall be tested. Those bits will then be compared to the corresponding bits of the files' (and folders') flags on the searched volume. If they are identical, you have a match.

The meaning of the flags are as follows (you can use BitwiseOr or + to combine them):
bit 15,value &H8000:isAlias
bit 14value &H4000:isInvisible
bit 13,value &H2000:hasBundle (has a BNDL resource)
bit 12,value &H1000:nameLocked
bit 11,value &H0800:isStationary
bit 10,value &H0400:hasCustomIcon
bit 8,value &H0100:hasBeenInited (Finder has seen the file since it has been created)
bit 7,value &H0080:hasNoINITs (there is no INIT rsrc in the Extension file)
bit 6,value &H0040:isShared
bits 1-3,value &H000E:color (as a 3-bit value from 0-7)

For example, to find only invisible files, use &H4000 for the FileFlagsMask and the same value for the FileFlags, or to find only visible files, use the same FileFlagsMask, but 0 for the FileFlags. To find stationaries that do not have a custom icon, use &H0C00 (=&H0800+&H0400) for the FileFlagsMask and &H0800 for the FileFlags.
(Read and Write property)

CatSearchMBS.FileFlagsMask as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The file flags mask to search for.
Example
dim c as CatSearchMBS
c.FileFlags=&H4000 // Invisible
c.FileFlagsMask=&H4000 // only look on the invisible flag

The above FileFlagsMask property allows you to specifiy the search criteria. Without setting any property from this class, a search will find nothing.

Note: If you set one of this properties, all criterias must match to get a match back from a call to SearchNext.

There is a FileFlags and a FileFlagsMask property which must be used together: bits set in FileFlagsMask specifiy which bits of FileFlags shall be tested. Those bits will then be compared to the corresponding bits of the files' (and folders') flags on the searched volume. If they are identical, you have a match.

The meaning of the flags are as follows (you can use BitwiseOr or + to combine them):
bit 15,value &H8000:isAlias
bit 14value &H4000:isInvisible
bit 13,value &H2000:hasBundle (has a BNDL resource)
bit 12,value &H1000:nameLocked
bit 11,value &H0800:isStationary
bit 10,value &H0400:hasCustomIcon
bit 8,value &H0100:hasBeenInited (Finder has seen the file since it has been created)
bit 7,value &H0080:hasNoINITs (there is no INIT rsrc in the Extension file)
bit 6,value &H0040:isShared
bits 1-3,value &H000E:color (as a 3-bit value from 0-7)

For example, to find only invisible files, use &H4000 for the FileFlagsMask and the same value for the FileFlags, or to find only visible files, use the same FileFlagsMask, but 0 for the FileFlags. To find stationaries that do not have a custom icon, use &H0C00 (=&H0800+&H0400) for the FileFlagsMask and &H0800 for the FileFlags.
(Read and Write property)

Some examples using this property:

CatSearchMBS.FileType as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The file type to look for.
Example
dim c as CatSearchMBS
c.FileType="TEXT"
' will look for plain Text files.

The above Creator property allows you to specifiy the search criteria. Without setting any property from this class, a search will find nothing.

Note: If you set one of this properties, all criterias must match to get a match back from a call to SearchNext.
(Read and Write property)

CatSearchMBS.LogicalDataForkSizeEnd as UInt64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The maximum logical data fork file size.
Example
dim c as CatSearchMBS
c.LogicalDataForkSizeStart=0
c.LogicalDataForkSizeEnd=102400 // search for files <= 100 KB.

You can assign -1 to have no upper limit.
(Read and Write property)

CatSearchMBS.LogicalDataForkSizeStart as UInt64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The minimum logical data fork file size.
Example
dim c as CatSearchMBS
c.LogicalDataForkSizeStart=0
c.LogicalDataForkSizeEnd=102400 // search for files <= 100 KB.

(Read and Write property)

CatSearchMBS.LogicalResForkSizeEnd as UInt64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The maximum logical resource fork file size.
Example
dim c as CatSearchMBS
c.LogicalResForkSizeStart=0
c.LogicalResForkSizeEnd=102400 // search for files <= 100 KB.

You can assign -1 to have no upper limit.
(Read and Write property)

CatSearchMBS.LogicalResForkSizeStart as UInt64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The minimum logical resource fork file size.
Example
dim c as CatSearchMBS
c.LogicalResForkSizeStart=0
c.LogicalResForkSizeEnd=102400 // search for files <= 100 KB.

(Read and Write property)

CatSearchMBS.ModificationDateEnd as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin 3.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The end of the modification date search range.

This value is an unsigned integer. If you assign a double from a date totalseconds property, please move it to the matching range like in the example project "Find stuff from today".
(Read and Write property)

Some examples using this property:

CatSearchMBS.ModificationDateStart as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin 3.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The start of the modification date search range.

This value is an unsigned integer. If you assign a double from a date totalseconds property, please move it to the matching range like in the example project "Find stuff from today".
(Read and Write property)

Some examples using this property:

CatSearchMBS.name as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
Set's the name for the search.
Example
dim c as CatSearchMBS
c.Name="Apple"
c.partialname=true

The above name property allows you to specifiy the search criteria. Without setting any property from this class, a search will find nothing.

Note: If you set one of this properties, all criterias must match to get a match back from a call to SearchNext.

If you pass true to the partialname property, you'll get a match any time the item's name contains the searched name. Otherwise, the intire name must match.

This property is encoded with system encoding. You need to convert strings from an editfield in RB 5 to match the system encoding which is not UTF8.
(Read and Write property)

CatSearchMBS.PartialName as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
whether or not the name property contains only a partial file name.
Example
dim c as CatSearchMBS
c.Name="Apple"
c.partialname=true

If you pass true to the partialname property, you'll get a match any time the item's name contains the searched name. Otherwise, the intire name must match.
(Read and Write property)

Some examples using this property:

CatSearchMBS.PhysicalDataForkSizeEnd as UInt64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The maximum physical data fork file size.
Example
dim c as CatSearchMBS
c.PhysicalDataForkSizeStart=0
c.PhysicalDataForkSizeEnd=102400 // search for files <= 100 KB.

You can assign -1 to have no upper limit.
(Read and Write property)

CatSearchMBS.PhysicalDataForkSizeStart as UInt64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The minimum physical data fork file size.
Example
dim c as CatSearchMBS
c.PhysicalDataForkSizeStart=0
c.PhysicalDataForkSizeEnd=102400 // search for files <= 100 KB.

(Read and Write property)

CatSearchMBS.PhysicalResForkSizeEnd as UInt64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The maximum physical resource fork file size.
Example
dim c as CatSearchMBS
c.PhysicalResForkSizeStart=0
c.PhysicalResForkSizeEnd=102400 // search for files <= 100 KB.

You can assign -1 to have no upper limit.
(Read and Write property)

CatSearchMBS.PhysicalResForkSizeStart as UInt64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
The minimum physical resource fork file size.
Example
dim c as CatSearchMBS
c.PhysicalResForkSizeStart=0
c.PhysicalResForkSizeEnd=102400 // search for files <= 100 KB.

(Read and Write property)

CatSearchMBS.ResponseTimeout as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
Sets the timeout for the search.
Example
dim c as CatSearchMBS
c.ResponseTimeout=1000 // one second

Sets the maximum time that may pass before SearchNext shall return even if no item has been found yet. The default is 15ms.

If you set the timeout to 0, then SearchNext will only return if an item has been found or if the search is finished.

Background:

Searching for a file or folder, especially if the volume does not support CatSearchMBS, can take a lot of time. While the search is in progress, you might want the user to give still access to your app's user interface. If SearchNext would only return once an item is found, the user interface might not be responsive for several seconds, up to minutes. RB's threads would not help here. To solve this, SearchNext returns in timely intervals even when it has nothing found yet. At that time, RB can respond to any user interaction, if necessary. This happens then automatically. All you have to do is to call SearchNext again.
(Read and Write property)

Some examples using this property:

CatSearchMBS.Result as folderitem

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the current file and returns nil if none was found.

After CatSearchNext has returned zero, this functions returns the found item else nil.
(Read and Write property)

CatSearchMBS.UsedCatSearchForLastSearch as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin ✅ Yes ❌ No ❌ No ✅ Yes All
whether the last search used the fast catalog search or the slow directory search.

(Read and Write property)

CatSearchMBS.UseIndexedSearch as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Catalog Search MBS MacClassic Plugin 3.4 ✅ Yes ❌ No ❌ No ✅ Yes All
Forces the class to use indexed search.

(Read and Write property)

Some examples using this property:

The items on this page are in the following plugins: MBS MacClassic Plugin.


The biggest plugin in space...