TElCustomFileSystemAdapter.EnumDirectoryEntries method

TElCustomFileSystemAdapter.EnumDirectoryEntries

Lists the directory contents.

Declaration

[C#]
int EnumDirectoryEntries(string Path, string Mask, bool Recursive, out TElVFSEntryInformationList EntryInfos);

[VB.NET]
Function EnumDirectoryEntries(ByVal Path As String, ByVal Mask As String, ByVal Recursive As Boolean, Out EntryInfos As TElVFSEntryInformationList) As Integer

[Pascal]
function EnumDirectoryEntries(const Path : string; const Mask : string; Recursive : boolean; var EntryInfos : TElVFSEntryInformationList) : integer; virtual;

[C++]
int32_t EnumDirectoryEntries(const std::string &Path, const std::string &Mask, bool Recursive, TElVFSEntryInformationList &EntryInfos);

[PHP]
integer EnumDirectoryEntries(string $Path, string $Mask, bool $Recursive, TElVFSEntryInformationList &$EntryInfos)

[Java]
int enumDirectoryEntries(String Path, String Mask, boolean Recursive, TElVFSEntryInformationList EntryInfos);

Parameters

Path - path to the directory to read.
Mask - specifies the mask (wildcards) to select the entry names. Only the entries which names match the mask will be listed.
Recursive - specifies whether to recursively list the contents of the subdirectories.
EntryInfos - the resulting entry info list will be stored here.

Return value

Returns a VFS error code.

Possible values:

Definition	Value	Description
ERROR_FACILITY_VFS	102400 (0x19000)	Base error code for VFS errors
ERROR_VFS_ERROR_FLAG	1024 (0x0400)	VFS error flag
ERROR_VFS_CUSTOM_ERROR_FLAG	2048 (0x0800)	VFS custom error flag
SB_VFS_ERROR_FILE_NOT_FOUND	103426 (0x19402)	File not found
SB_VFS_ERROR_PATH_NOT_FOUND	103427 (0x19403)	Path not found
SB_VFS_ERROR_ACCESS_DENIED	103429 (0x19405)	Access denied
SB_VFS_ERROR_WRITE_PROTECT	103443 (0x19413)	The file is write-protected
SB_VFS_ERROR_ERROR_CRC	103447 (0x19417)	CRC error
SB_VFS_ERROR_NOT_SUPPORTED	103474 (0x19432)	Operation not supported
SB_VFS_ERROR_INVALID_PARAMETER	103511 (0x19457)	Invalid parameter encountered when accessing directory entries
SB_VFS_ERROR_NO_MEDIA	104536 (0x19858)	Storage media is not accessible
SB_VFS_UNSPECIFIED_ERROR	104448 (0x19800)	Any unspecified error

Description

Call this method to list the contents of the directory.