VCOM:VectorWorks:Filing:IFileChooserDialog::AddFilter

From Vectorworks Developer
Jump to navigation Jump to search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::Filing

Member of VCOM:VectorWorks:Filing:IFileChooserDialog

Add single file filter or an array of file filter to the filter list of the dialog. 

virtual VCOMError VCOM_CALLTYPE AddFilter(
                      const TXString&   filterExt,
                      const TXString&   filterDesc) = 0;
virtual VCOMError VCOM_CALLTYPE AddFilter(
                      const TXStringArray&   arrFilterExts,
                      const TXString&        filterDesc) = 0;

Parameters

arrFilterExts const TXStringArray& Array of filter extensions that are to be added.

filterExt const TXString& The filter extension that is to be added.
filterDesc const TXString& The filter description text that is to appear with the filter.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the fuction.
kVCOMError_Failed Routine failed.

See Also

VCOM:VectorWorks:Filing:IFolderIdentifier | VCOM:VectorWorks:Filing:IFileIdentifier | VCOM:VectorWorks:Filing:IFileChooserDialog

[[VCOM:VectorWorks:Filing:IFolderIdentifier]] | [[VCOM:VectorWorks:Filing:IFileIdentifier]] | [[VCOM:VectorWorks:Filing:IFileChooserDialog]]
Retrieved from "http://developer.vectorworks.net/index.php?title=VCOM:VectorWorks:Filing:IFileChooserDialog::AddFilter&oldid=9313"