wpclsQueryOpenFolders
This class method enumerates all open folders for the specified class.
Syntax
_wpclsQueryOpenFolders(somSelf, Folder, ulOption, fLock)
Parameters
- somSelf (M_WPFolder *) - input
- Pointer to the WPFolder class object.
- Folder (WPFolder *) - input
- Pointer to a folder object. This field is ignored unless `QC_NEXT` is specified in ulOption.
- ulOption (ULONG) - input
- Flag indicating the folder to query. Possible values are described in the following list:
- `QC_FIRST` Return the first open folder in the open-folder list. This value is specified on the class object if the passed object is not currently open.
- `QC_LAST` Return the last open folder.
- `QC_NEXT` Return the next open folder after Folder in the list.
- fLock (BOOL) - input
- Lock the object flag. Possible values are described in the following list:
- `TRUE` The new flag will remain active until the caller issues wpUnlockObject on it.
- `FALSE` The newly created object will be made dormant whenever the object and the folder containing the object are closed.
- FldrObject (WPFolder *) - returns
- Pointer to the specified folder object. A return value of NULL indicates that either an error occurred or `QC_NEXT` was requested on the last folder.
Returns
- FldrObject (WPFolder *) - returns
- Pointer to the specified folder object. A return value of NULL indicates that either an error occurred or `QC_NEXT` was requested on the last folder.
Remarks
This method can be called at any time.
How to Override
This method is generally not overridden.
Usage
This method can be called at any time.