The include file files.h


DIR_

Options for the dir() function.


DIR_FILES

Return standard files.

DIR_DIRS

Return directory names (pattern is ignored).

DIR_RMEXTN

Remove filename extensions.

DIR_NATIVE

Keep native filename. If this is specified, filenames are returned in native format with no conversion. If not, filenames in MS-DOS/Windows are folded to lower case.


DIRX_

Since Sculptor version 6.2.0 these options can be used in the dir_to_file() function.


DIRX_SIZE

Fills in FileSize

DIRX_CREATED

Fills in Created

DIRX_UPDATED

Fills in Updated

DIRX_ACCESSED

Fills in Accessed


FILETYPE_

Definitions of the file types which may be returned from the dir() function.


FILETYPE_FILE

1

File

FILETYPE_DIR

2

Directory


FOM_

File modes. The read-only File state clause is used to test these values for a Sculptor keyed file declared in a program. FOM_READ can also be used to set File report mode to an automatically read file in a report (!drive or !xfile) at run time.


FOM_CLOSED

0

File is closed

FOM_READ

1

File is open in read-only mode

FOM_CREATE

2

File is open in create mode

FOM_UPDATE

3

File is open in update mode


GFN_

Flags for use with the get_filename() function. Described in more detail in the section on that function.


GFN_READONLY

Initially check read-only box

GFN_OVERWRITEPROMPT

Prompt before overwriting existing file

GFN_SHOWREADONLY

Show the read-only checkbox

GFN_SHOWHELP

Show the help button

GFN_GETSAVEFILE

Get filename for Save As

GFN_ALLOWMULTISELECT

Allow multiple filenames

GFN_ALLOWNEWPATH

Typed pathname need not exist

GFN_ALLOWNEWFILE

Typed filename need not exist

GFN_CREATEPROMPT

Confirm if file does not exist


TEST_

Flags for use with the access() function.


TEST_EXISTS

Check if the file exists

TEST_CANEXEC

Check if current user has execute permission

TEST_CANREAD

Check if current user has read permission

TEST_CANWRITE

Check if current user has write permission


FILEINFO_

Flags for use with the mode argument in the fileinfo() function.


FILEINFO_TYPE

File type mask

FILEINFO_ISFIFO

Pipe

FILEINFO_ISCHR

Character special file

FILEINFO_ISDIR

Directory

FILEINFO_ISBLK

Block special file (Unix)

FILEINFO_ISREG

Regular file


PERMS_

Flags for use with the chmod(), fileinfo(), mkdir() , create_shared_memory() and link_shared_memory() functions. Not all permission types are used by MSDOS/Windows; invalid flags are ignored. See the documentation on each individual function for details.


PERMS_RDOWNER

Give owner read permission

PERMS_WROWNER

Give owner write permission

PERMS_EXOWNER

Give owner execute permission

PERMS_RDGROUP

Give group read permission

PERMS_WRGROUP

Give group write permission

PERMS_EXGROUP

Give group execute permission

PERMS_RDOTHER

Give others read permission

PERMS_WROTHER

Give others write permission

PERMS_EXOTHER

Give others execute permission

Several useful combinations of these flags are also included:

PERMS_R

Give owner read permission (same as PERMS_RDOWNER)

PERMS_RW

Give owner read and write permission

PERMS_RWX

Give owner read, write and execute permission

PERMS_RR

Give owner and group read permission

PERMS_RWR

Give owner read and write permission, and group read permission

PERMS_RWRW

Give owner and group read and write permission

PERMS_RWXRX

Give owner read, write and execute permission, and group read and execute permission

PERMS_RWXRWX

Give owner and group read, write and execute permission

PERMS_RRR

Give owner, group and others read permission

PERMS_RWRR

Give owner, group and others read permission, and owner write permission

PERMS_RWRWR

Give owner, group and others read permission, and owner and group write permission

PERMS_RWRWRW

Give owner, group and others read and write permission

PERMS_RWXRXRX

Give owner read, write and execute permission, and group and others read and execute permission

PERMS_RWXRWXRX

Give owner and group read, write and execute permission, and others read and execute permission

PERMS_RWXRWXRWX

Give owner, group and others read, write and execute permission


BIF_

Flags for use with the browse_for_folder() function. Described in more detail in the section on that function. If further information is required, refer to the Microsoft SHBrowseForFolder() function.


BIF_BROWSEFORCOMPUTER

Browse for a computer.

BIF_BROWSEFORPRINTER

Browse for a printer.

BIF_BROWSEINCLUDEFILES

Browse for files and folders.

BIF_BROWSEINCLUDEURLS

Allow URLs.

BIF_DONTGOBELOWDOMAIN

Exclude network folders below domain .

BIF_EDITBOX

Include an edit box.

BIF_NEWDIALOGSTYLE

Use new dialog layout with resize.

BIF_NONEWFOLDERBUTTON

Exclude the “New Folder” button. Valid only with BIF_NEWDIALOGSTYLE.

BIF_NOTRANSLATETARGETS

Don’t convert shortcut to target.

BIF_RETURNFSANCESTORS

Return file system ancestors only.

BIF_RETURNONLYFSDIRS

Return file system directories only.

BIF_UAHINT

Add a UA hint to the dialog. Cannot be used with BIF_EDITBOX.


CSIDL_

Folder identifiers for use with the browse_for_folder() function.


CSIDL_ADMINTOOLS

<user_name>\Start Menu\Programs\Administrative Tools

CSIDL_ALTSTARTUP

non-localised startup

CSIDL_APPDATA

<user_name>\Application Data

CSIDL_BITBUCKET

<desktop>\Recycle Bin

CSIDL_COOKIES

Cookies

CSIDL_COMMON_ADMINTOOLS

All Users\Start Menu\Programs\Administrative Tools

CSIDL_COMMON_ALTSTARTUP

Non-localized common startup

CSIDL_COMMON_APPDATA

All Users\Application Data

CSIDL_COMMON_DESKTOPDIRECTORY

All Users\Desktop

CSIDL_COMMON_DOCUMENTS

All Users\Documents

CSIDL_COMMON_FAVORITES

Favourites

CSIDL_COMMON_MUSIC

All Users\My Music

CSIDL_COMMON_PICTURES

All Users\My Pictures

CSIDL_COMMON_PROGRAMS

All Users\Start Menu\Programs

CSIDL_COMMON_STARTMENU

All Users\Start Menu

CSIDL_COMMON_STARTUP

All Users\Startup

CSIDL_COMMON_TEMPLATES

All Users\Templates

CSIDL_COMMON_VIDEO

All Users\My Video

CSIDL_COMPUTERSNEARME

Computers Near Me

CSIDL_CONNECTIONS

Network and Dial-up Connections

CSIDL_CONTROLS

My Computer\Control Panel

CSIDL_DESKTOP

Desktop

CSIDL_DESKTOPDIRECTORY

<user_name>\Desktop

CSIDL_DRIVES

My Computer

CSIDL_FAVORITES

<user_name>\Favourites

CSIDL_FONTS

Windows Fonts

CSIDL_HISTORY

History

CSIDL_INTERNET_CACHE

Internet cache

CSIDL_LOCAL_APPDATA

<user_name>\Local Settings\Application Data (non roaming)

CSIDL_MYMUSIC

“My Music” folder

CSIDL_MYPICTURES

\Program Files\My Pictures

CSIDL_MYVIDEO

“My Videos” folder

CSIDL_NETHOOD

<user_name>\nethood

CSIDL_NETWORK

Network Neighborhood

CSIDL_PERSONAL

My Documents

CSIDL_PRINTERS

<user_name>\PrintHood

CSIDL_PROFILE

User Profile

CSIDL_PROGRAMS

Start Menu\Programs

CSIDL_PROGRAM_FILES

\Program Files

CSIDL_PROGRAM_FILES_COMMON

\Program Files\Common

CSIDL_RECENT

<user_name>\Recent

CSIDL_RESOURCES

Resource Directory

CSIDL_RESOURCES_LOCALIZED

Localized Resource Directory

CSIDL_STARTMENU

<user_name>\Start Menu

CSIDL_STARTUP

Start Menu\Programs\Startup

CSIDL_SYSTEM

System Directory

CSIDL_TEMPLATES

Templates

CSIDL_WINDOWS

Windows Directory

CSIDL_FLAG_CREATE

Combine with other value to force folder creation


RELATED TOPICS

Standard include files