BBjFileChooser::getFileFilterContents

Description

In BBj 7.0 and higher, invoke this BBjFileChooser method to obtain the list of filter strings currently assigned to the given filter name.

Syntax

Return Value

Method

BBjVector

getFileFilterContents(string name)

Parameters

Variable

Description

name

The name of the filter.

Return Value

Returns a BBjVector containing the strings that represent the file globs for the file filter named.

Remarks

File filters added with the addFileFilter(string, string) method will appear as a vector containing only one element.

If no file filter with the given name exists, this method throws an !ERROR=17.

Although the "All Files" filter does exist in the list of file filters, it does not have any strings associated with it. Passing the empty string also causes the method to throw an !ERROR=17.

Example

See Also

BBjAPI

BBjSysGui

BBjWindow

BBjFileChooser

   BBjFileChooser::addFileFilter

   BBjFileChooser::getActiveFileFilter

   BBjFileChooser::getFileFilterNames

   BBjFileChooser::removeFileFilter

   BBjFileChooser::setActiveFileFilter

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.