Directory entry


Section contents


Overview

Defined in

cfile.oxh

Description

<TBS>


Construction / destruction


NewEntry - Constructor

Usage

this& = NewEntry&:

Description

Creates a directory entry object and returns a handle which allows the object to be manipulated.

Return Value
this& An value which represents the created directory entry
Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.

Example
  LOCAL this&

  this& = NewEntry&:
  DeleteEntry:(this&) 

DeleteEntry - Destructor

Usage

DeleteEntry:(BYREF this&)

Description

Destroys the directory entry object.

Arguments
BYREF this& A handle to a directory entry object
Example
  LOCAL this&

  this& = NewEntry&:
  DeleteEntry:(this&) 

Methods provided


EntryAtt - get attributes

Usage

attributes& = EntryAtt&:(this&)

Description

Gets the attributes.

Arguments
this& A handle to a directory entry object
Return value
attributes& The file attributes

EntryIsArchive - whether archive file

Usage

bool% = EntryIsArchive%:(this&)

Description

Gets whether the entry this& is for an archive file.

Arguments
this& A handle to a directory entry object
Return value
bool% Returns KTrue% (-1) if an archive file entry, otherwise returns KFalse% (0)

EntryIsDir - whether a directory

Usage

bool% = EntryIsDir%:(this&)

Description

Gets whether the entry this& is for a directory.

Arguments
this& A handle to a directory entry object
Return value
bool% Returns KTrue% (-1) if a directory entry, otherwise returns KFalse% (0)

EntryIsHidden - whether a hidden entry

Usage

bool% = EntryIsHidden%:(this&)

Description

Gets whether the entry this& is for a hidden entry.

Arguments
this& A handle to a directory entry object
Return value
bool% Returns KTrue% (-1) if a hidden entry, otherwise returns KFalse% (0)

EntryIsReadOnly - whether a readonly entry

Usage

bool% = EntryIsHidden%:(this&)

Description

Gets whether the entry this& is for a readonly entry.

Arguments
this& A handle to a directory entry object
Return value
bool% Returns KTrue% (-1) if a readonly entry, otherwise returns KFalse% (0)

EntryIsSystem - whether a system entry

Usage

bool% = EntryIsSystem%:(this&)

Description

Gets whether the entry this& is for a system entry.

Arguments
this& A handle to a directory entry object
Return value
bool% Returns KTrue% (-1) if a system entry, otherwise returns KFalse% (0)

EntryIsTypeValid - whether UID type valid

Usage

bool% = EntryIsTypeValid%:(this&)

Description

Gets whether the entry this& has a valid UID.

Arguments
this& A handle to a directory entry object
Return value
bool% Returns KTrue% (-1) if UID exists and is valid, otherwise returns KFalse% (0)

EntryIsUidPresent - whether specific UID present

Usage

bool% = EntryIsUidPresent%:(this&,uid&)

Description

Gets whether the entry this& has a UID which matches uid&.

Arguments
this& A handle to a directory entry object
uid& A UID to find
Return value
bool% Returns KTrue% (-1) if the specified UID is found, otherwise returns KFalse% (0)

EntryMostDerivedUid - most derived UID

Usage

uid& = EntryMostDerivedUid&:(this&)

Description

Gets most derived (specific) UID.

Arguments
this& A handle to a directory entry object
Return value
uid& Returns the most derived UID

EntryModified - the modification time

Usage

time& = EntryModified&:(this&)

Description

Gets the time that the entry was last modified.

Arguments
this& A handle to a directory entry object
Return value
time& Returns a handle to a time object

EntryName - the entry name

Usage

name$ = EntryName$:(this&)

Description

Gets the name of the entry this&.

Arguments
this& A handle to a directory entry object
Return value
name$ The name of the entry
Error Handling

If the name$ string cannot be created then an error is generated which should be trapped by an ONERR handler.


EntrySize - the size of the entry

Usage

size& = EntrySize&:(this&)

Description

Gets the size of the entry this&.

Arguments
this& A handle to a directory entry object
Return value
size& The size of the entry

EntryType - the UID type of the entry

Usage

uidtype& = EntryType&:(this&)

Description

Gets the UID type of the entry this&.

Arguments
this& A handle to a directory entry object
Return value
uidtyp& The UID type of the entry

EntryUid - get a UID

Usage

uid& = EntryUid&:(this&,index%)

Description

Get the UID whose index is index% of the entry this&.

Arguments
this& A handle to a directory entry object
index% The index of the uid to return. Must be between 0 and 2
Return value
uid& The UID type of the entry