VCOM:VectorWorks:Filing:IApplicationFolders::ForEachFolderInStandardFolderClass

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:IApplicationFolders

For each folder in the given folder class, calls a given function pointer. The folders are returned in search path order, i.e. [User], [Workgroups*], [App]. Only folders that currently exist will be returned, so it is same to assume the folder exists. 

virtual VCOMError VCOM_CALLTYPE ForEachFolderInStandardFolderClass(
                                  IFolderContentListener*   pVisitor,
                                  EFolderSpecifier          folderSpec) = 0;

Parameters

pListener IFolderContentListener* A listener object whose member OnFileContent will be called with each existing, uniquely-named file. See IFolderIdentifier::EnumerateContents
folderSpec EFolderSpecifier The folder class to obtain files from.

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:IApplicationFolders

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