File System Related Methods

A program or Workplace Shell object would call the following methods to get information about a file system object. These methods are not normally overridden.

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryAttr                   │Returns the file attributes of│
│                              │the file system object.       │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryCreation               │Returns the creation date and │
│                              │time of the file system       │
│                              │object.                       │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryDateInfo               │Returns the file system       │
│                              │object's:                     │
│                              │                              │
│                              │o Creation date and time      │
│                              │o Last access date and timeo  │
│                              │o Last update date and time.  │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryDisk                   │Returns the pointer to the    │
│                              │disk object for the drive on  │
│                              │which the file system object  │
│                              │resides.                      │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryEASize                 │Returns the size, in bytes, of│
│                              │the extended attributes of the│
│                              │file system object.           │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryEASupport              │Determines whether extended   │
│                              │attributes are supported for  │
│                              │the specified file system     │
│                              │object.                       │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryFilename               │Returns the name of the file  │
│                              │system object.                │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryFileSize               │Returns the size, in bytes, of│
│                              │the file system object.       │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryLastAccess             │Returns the last access date  │
│                              │and time of the file system   │
│                              │object.                       │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryLastWrite              │Returns the last write date   │
│                              │and time of the file system   │
│                              │object.                       │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryRealName               │Returns the real name of the  │
│                              │file system object. For file  │
│                              │systems that do not support   │
│                              │long file names, such as the  │
│                              │FAT file system which allows 8│
│                              │characters for the file name  │
│                              │and 3 for the extension, the  │
│                              │real name may be different    │
│                              │than the object's title.      │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryRefreshFlags           │Queries the refresh flags for │
│                              │a file system object.  The    │
│                              │refresh flags consist of a    │
│                              │DIRTYBIT and a FOUNDBIT that  │
│                              │are used to allow refresh to  │
│                              │detect deleted files and new  │
│                              │files after asking a folder to│
│                              │re-populate.                  │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryType                   │Returns the type of the file  │
│                              │system object.                │
├──────────────────────────────┼──────────────────────────────┤
│wpclsQueryAwakeObject         │Returns the pointer to the    │
│                              │file system object            │
│                              │corresponding to the specified│
│                              │path name, if the file system │
│                              │object is awake.              │
├──────────────────────────────┼──────────────────────────────┤
│wpclsQueryInstanceFilter      │Returns a string containing   │
│                              │the filter for files that     │
│                              │comprise the object class.    │
├──────────────────────────────┼──────────────────────────────┤
│wpclsQueryInstanceType        │Returns a string containing   │
│                              │the .TYPE attribute for the   │
│                              │files that comprise the object│
│                              │class.                        │
├──────────────────────────────┼──────────────────────────────┤
│wpclsQueryObjectFromPath      │Returns the pointer to an     │
│                              │object which represents the   │
│                              │given file or directory.      │
└──────────────────────────────┴──────────────────────────────┘

A program or Workplace Shell object would call the following methods to set information about a file system object. These methods are not normally overridden.

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpSetAttr                     │Changes the file attributes of│
│                              │the file system object.       │
├──────────────────────────────┼──────────────────────────────┤
│wpSetDateInfo                 │Changes the file system       │
│                              │object's:                     │
│                              │                              │
│                              │o Creation date and time      │
│                              │o Last access date and timeo  │
│                              │o Last update date and time.  │
│                              │                              │
│                              │Note:                         │
│                              │This method changes only the  │
│                              │dates and times kept in the   │
│                              │persistent data of the file   │
│                              │system object.  It does not   │
│                              │change the actual dates and   │
│                              │times kept by the underlying  │
│                              │file system.                  │
├──────────────────────────────┼──────────────────────────────┤
│wpSetFileSizeInfo             │Changes the file size and     │
│                              │extended attribute size of the│
│                              │file system object.           │
│                              │                              │
│                              │Note:                         │
│                              │This method changes only      │
│                              │the sizes kept in the         │
│                              │persistent data of the file   │
│                              │system object.  It does not   │
│                              │change the actual sizes used  │
│                              │by the underlying file        │
│                              │system.                       │
├──────────────────────────────┼──────────────────────────────┤
│wpSetRealName                 │Changes the real name of the  │
│                              │file system object. This is   │
│                              │the name of the object        │
│                              │maintained by the underlying  │
│                              │file system.                  │
├──────────────────────────────┼──────────────────────────────┤
│wpSetTitleAndRenameFile       │Changes the file system       │
│                              │object's title and real name, │
│                              │so that they match.           │
├──────────────────────────────┼──────────────────────────────┤
│wpSetType                     │Changes the .TYPE attribute of│
│                              │the file system object.       │
└──────────────────────────────┴──────────────────────────────┘


[Back: Disk (File-System Device) Related Methods]
[Next: Folder Related Methods]