plugins/include/files.inc
author David Anderson <dvander@alliedmods.net>
Mon Jan 01 19:50:16 2007 +0000 (2007-01-01)
changeset 252 ce166c465bad
child 257 583a23434070
permissions -rw-r--r--
added usage of the Handle System to begin experimenting
dvander@252
     1
/**
dvander@252
     2
 * :TODO: license info
dvander@252
     3
 */
dvander@252
     4
dvander@252
     5
#if defined _files_included
dvander@252
     6
 #endinput
dvander@252
     7
#endif
dvander@252
     8
#define _files_included
dvander@252
     9
dvander@252
    10
/* @note All paths in SourceMod natives are relative to the mod folder unless otherwise noted. */
dvander@252
    11
 
dvander@252
    12
enum FileType
dvander@252
    13
{
dvander@252
    14
	FileType_Unknown = 0,	/* Unknown file type (device/socket) */
dvander@252
    15
	FileType_Directory = 1,	/* File is a directory */
dvander@252
    16
	FileType_File = 2,		/* File is a file */
dvander@252
    17
};
dvander@252
    18
dvander@252
    19
dvander@252
    20
/**
dvander@252
    21
 * @brief Opens a directory/folder for contents enumeration.
dvander@252
    22
 * @note Directories are closed with CloseHandle().
dvander@252
    23
 * @note Directories Handles can be cloned.
dvander@252
    24
 *
dvander@252
    25
 * @param path			Path to open.
dvander@252
    26
 * @return			A Handle to the directory, INVALID_HANDLE on open error.
dvander@252
    27
 */
dvander@252
    28
native Handle:OpenDirectory(const String:path[]);
dvander@252
    29
dvander@252
    30
/**
dvander@252
    31
 * @brief Reads the current directory entry as a local filename, then moves to the next file.
dvander@252
    32
 * @note Contents of buffers are undefined when returning false.
dvander@252
    33
 * @note Both the '.' and '..' automatic directory entries will be retrieved for Windows and Linux.
dvander@252
    34
 * 
dvander@252
    35
 * @param dir			Handle to a directory.
dvander@252
    36
 * @param buffer		String buffer to hold directory name.
dvander@252
    37
 * @param maxlength		Maximum size of string buffer.
dvander@252
    38
 * @param type			Optional variable to store the file type.
dvander@252
    39
 * @return			True on success, false if there are no more files to read.
dvander@252
    40
 * @error				Invalid or corrupt Handle. 
dvander@252
    41
 */
dvander@252
    42
native bool:ReadDirEntry(Handle:dir, String:buffer[], maxlength, &FileType:type=0);