Main Page Cookbook/Overview ImageMeister the jcprops file Licensing Binary Installation & Configuration [ Win · Mac · Nix ] Changes Public API Source Code Main Page Java [ Common · Win · Mac · Nix ] Native Code [ Common · Win · Mac · Nix ] Manifest Native Code Overviews [ Common · Win · Mac · Nix · Strings ] Macros [ General · Native Macros ] Walkthroughs [ Java only · Java and native ] Building [ Win · Mac · Nix ] Distribution Issues

    All Packages  This Package  Class Hierarchy  Class Search  Index

Interface com.jconfig.nix.AppUtilsNixI

Summary

    interface  AppUtilsNixI
    {
              // Fields 37
         public static final int DATE_ACC_OFFSET;
         public static final int DATE_CRE_OFFSET;
         public static final int DATE_MOD_OFFSET;
         public static final String copyrightString;
         public static final int kDateBundleArrayLen;
         public static final int kGetMntEntOffs_dir;
         public static final int kGetMntEntOffs_fsname;
         public static final int kGetMntEntOffs_opts;
         public static final int kGetMntEntOffs_type;
         public static final int kGetMntEntRetArrayLen;
         public static final int kMonitorInfoNumInts;
         public static final int kResolveLinkFileNoUI;
         public static final int kResolveLinkFileUI;
         public static final int kStandardFileAttrsMask;
         public static final int kStandardVolumeAttrsMask;
         public static final int kStatFSOffs_bavail;
         public static final int kStatFSOffs_bfree;
         public static final int kStatFSOffs_blocks;
         public static final int kStatFSOffs_bsize;
         public static final int kStatFSOffs_ffree;
         public static final int kStatFSOffs_files;
         public static final int kStatFSOffs_fsid0;
         public static final int kStatFSOffs_fsid1;
         public static final int kStatFSOffs_type;
         public static final int kStatFSRetArrayLen;
         public static final int kStatOffs_blksize;
         public static final int kStatOffs_blocks;
         public static final int kStatOffs_dev;
         public static final int kStatOffs_gid;
         public static final int kStatOffs_ino;
         public static final int kStatOffs_mode;
         public static final int kStatOffs_nlink;
         public static final int kStatOffs_rdev;
         public static final int kStatOffs_size;
         public static final int kStatOffs_uid;
         public static final int kStatRetArrayLen;
         public static final int kUnused;

              // Methods 35
         public abstract int createFileAlias(String, String, int);
         public abstract int createVolumeAlias(String, String, int);
         public abstract String[] findAppsByExtension(String, int, int);
         public abstract String[] findAppsByName(String, int, int);
         public abstract int getAllMonitorInfo(int[], int, int[]);
         public abstract int getDriveDisplayName(String, String[]);
         public abstract int getExecutableType(String, int[]);
         public abstract int getExtIcon(String, int, int, int, int, int, int[]);
         public abstract int getFileAttributes(String, int[]);
         public abstract int getFileAttributesMask(String, int[]);
         public abstract int getFileIcon(String, boolean, int, int, int, int, int, int[]);
         public abstract int getMainMonitorInfo(int[]);
         public abstract int getMntEnt(String[], int, int[]);
         public abstract int getVolumeFlags(String, int[]);
         public abstract int getVolumeIcon(String, int, int, int, int, int, int[]);
         public abstract int getVolumeLabel(String, String[]);
         public abstract int getVolumeMaxFileNameLength(String, int[]);
         public abstract int getVolumeReadFlagsMask(String, int[]);
         public abstract int getVolumeReferenceNumber(String, int[]);
         public abstract int getVolumes(int, int[], String[]);
         public abstract boolean isDrivePath(File);
         public abstract boolean isDriveString(String);
         public abstract boolean isLinkFile(File);
         public abstract int launchApp(String, String, String, String, int[], int, String[]);
         public abstract int launchURL(String, int, String[]);
         public abstract int lstat(String, int[], int[]);
         public abstract int moveApp(int[], int, int);
         public abstract String pathToDriveName(File);
         public abstract int quitApp(int[], int);
         public abstract int readLink(String, String[]);
         public abstract int resolveLinkFile(String, String[], int);
         public abstract int setVolumeLabel(String, String);
         public abstract int stat(String, int[], int[]);
         public abstract int statFS(String, int[]);
         public abstract int verifyNativeAppData(int[]);
    }

This is a preliminary interface derived from AppUtilsMSVM.

It is implemented by AppUtilsNixLinux (for Linux) and AppUtilsNixPlain (for all other Unix systems)

Author:
  Copyright (c) 1997,1998,1999,2000 Samizdat Productions. All Rights Reserved.

Cross Reference

Implemented By:
  AppUtilsNixPlain

Fields

### · copyrightString | Summary | Top

       public static final String copyrightString

### · kUnused | Summary | Top

       public static final int kUnused

### · kDateBundleArrayLen | Summary | Top

       public static final int kDateBundleArrayLen

> The stat() and lstat() methods are passed an array of java ints, into which the native code puts the modification, creation and access dates. Each date takes 6 ints: year, month, day, hour, minute, and second. These define the total length of the jint array, and the offset of each date.

### · DATE_MOD_OFFSET | Summary | Top

       public static final int DATE_MOD_OFFSET

### · DATE_CRE_OFFSET | Summary | Top

       public static final int DATE_CRE_OFFSET

### · DATE_ACC_OFFSET | Summary | Top

       public static final int DATE_ACC_OFFSET

### · kStatFSOffs_type | Summary | Top

       public static final int kStatFSOffs_type

> The statFS() method is passed an array of ints, into which the native code information on a file system. These constants define the total length of the array, and the offset of each item.

### · kStatFSOffs_bsize | Summary | Top

       public static final int kStatFSOffs_bsize

### · kStatFSOffs_blocks | Summary | Top

       public static final int kStatFSOffs_blocks

### · kStatFSOffs_bfree | Summary | Top

       public static final int kStatFSOffs_bfree

### · kStatFSOffs_bavail | Summary | Top

       public static final int kStatFSOffs_bavail

### · kStatFSOffs_files | Summary | Top

       public static final int kStatFSOffs_files

### · kStatFSOffs_ffree | Summary | Top

       public static final int kStatFSOffs_ffree

### · kStatFSOffs_fsid0 | Summary | Top

       public static final int kStatFSOffs_fsid0

### · kStatFSOffs_fsid1 | Summary | Top

       public static final int kStatFSOffs_fsid1

### · kStatFSRetArrayLen | Summary | Top

       public static final int kStatFSRetArrayLen

### · kGetMntEntOffs_fsname | Summary | Top

       public static final int kGetMntEntOffs_fsname

> The getMntEnt() method is passed an array of Strings, into which the native code information on a file system. These constants define the total length of the array, and the offset of each item.

### · kGetMntEntOffs_dir | Summary | Top

       public static final int kGetMntEntOffs_dir

### · kGetMntEntOffs_type | Summary | Top

       public static final int kGetMntEntOffs_type

### · kGetMntEntOffs_opts | Summary | Top

       public static final int kGetMntEntOffs_opts

### · kGetMntEntRetArrayLen | Summary | Top

       public static final int kGetMntEntRetArrayLen

### · kStatOffs_dev | Summary | Top

       public static final int kStatOffs_dev

> The stat() method is passed an array of ints, into which the native code information on a file. These constants define the total length of the array, and the offset of each item.

### · kStatOffs_ino | Summary | Top

       public static final int kStatOffs_ino

### · kStatOffs_mode | Summary | Top

       public static final int kStatOffs_mode

### · kStatOffs_nlink | Summary | Top

       public static final int kStatOffs_nlink

### · kStatOffs_uid | Summary | Top

       public static final int kStatOffs_uid

### · kStatOffs_gid | Summary | Top

       public static final int kStatOffs_gid

### · kStatOffs_rdev | Summary | Top

       public static final int kStatOffs_rdev

### · kStatOffs_size | Summary | Top

       public static final int kStatOffs_size

### · kStatOffs_blksize | Summary | Top

       public static final int kStatOffs_blksize

### · kStatOffs_blocks | Summary | Top

       public static final int kStatOffs_blocks

### · kStatRetArrayLen | Summary | Top

       public static final int kStatRetArrayLen

### · kMonitorInfoNumInts | Summary | Top

       public static final int kMonitorInfoNumInts

> Used in retrieving monitor information; see the 'getAllMonitorInfo' method.

### · kResolveLinkFileNoUI | Summary | Top

       public static final int kResolveLinkFileNoUI

> See the 'resolveLinkFile' method.

### · kResolveLinkFileUI | Summary | Top

       public static final int kResolveLinkFileUI

> See the 'resolveLinkFile' method.

### · kStandardVolumeAttrsMask | Summary | Top

       public static final int kStandardVolumeAttrsMask

### · kStandardFileAttrsMask | Summary | Top

       public static final int kStandardFileAttrsMask

Methods

### · getMntEnt | Summary | Top

       public abstract int getMntEnt(String[] retQuads,
                                     int maxToReturn,
                                     int[] numReturned)

> Calls the Unix getmntent() routine to get a list of mounted file systems.

> Parameter | Description
> retQuads | on return, 4 strings about each file system will be stored in this array, corresponding to the following fields of the 'mntent' struct: mnt_fsname, mnt_dir, mnt_type, and mnt_opts
> maxToReturn | the maximum number to return. the length of retQuads should be 4 times this value
> numReturned | the number of file systems on which information is returned. The number of strings in 'retQuads' will be 4 times this number

### · statFS | Summary | Top

       public abstract int statFS(String fileName,
                                  int[] retInts)

> Calls the Unix statfs() routine to return information on the file system containing the given file

> Parameter | Description
> fileName | the full path of the file
> retInts | on exit, stats on the file system will be placed at offsets defined by the kStatFSOffs_XXX constants. This array must have at least kStatFSRetArrayLen elements.

### · stat | Summary | Top

       public abstract int stat(String fileName,
                                int[] retArray,
                                int[] datesArray)

> Calls the Unix stat() routine to return information on the given file

> Parameter | Description
> fileName | the full path of the file
> retArray | on exit, stats on the file will be placed at offsets defined by the kStatOffs_XXX constants. This array must have at least kStatRetArrayLen elements.
> datesArray | on exit, stats on the file system will be placed at offsets defined by the kXXXDateOffset constants. This array must have at least kDateBundleArrayLen elements.

### · lstat | Summary | Top

       public abstract int lstat(String fileName,
                                 int[] retArray,
                                 int[] datesArray)

> Calls the Unix lstat() routine to return information on the given file

> Parameter | Description
> fileName | the full path of the file
> retArray | on exit, stats on the file will be placed at offsets defined by the kStatOffs_XXX constants. This array must have at least kStatRetArrayLen elements.
> datesArray | on exit, stats on the file system will be placed at offsets defined by the kXXXDateOffset constants. This array must have at least kDateBundleArrayLen elements.

### · readLink | Summary | Top

       public abstract int readLink(String linkFilePath,
                                    String[] retPath)

> Calls the Unix readlink() routine to resolve a symbolic link.

> Parameter | Description
> linkFilePath | the full path (which may be a symbolic link) to resolve
> retPath | on return, contains the full path of the resolved file

### · getFileIcon | Summary | Top

       public abstract int getFileIcon(String fullPath,
                                       boolean bIsDir,
                                       int whichIcon,
                                       int w,
                                       int h,
                                       int xform,
                                       int align,
                                       int[] pData)

> Gets the icon for a file.
> WANC

> Parameter | Description
> fullPath | full path of the file
> bIsDir | is this a directory?
> whichIcon | either IconBundle.ICON_LARGE or IconBundle.ICON_SMALL
> w | the width of the icon
> h | the height of the icon
> xform | any transformation to be applied to the icon
> align | any alignment to be applied to the icon
> pData | an array of ints which will hold the Java format ARGB data for the icon This must have at least w * h elements

### · getExtIcon | Summary | Top

       public abstract int getExtIcon(String ext,
                                      int whichIcon,
                                      int w,
                                      int h,
                                      int xform,
                                      int align,
                                      int[] pData)

> Gets the icon for files ending in the given extension.
> WANC

> Parameter | Description
> ext | the extension
> whichIcon | either IconBundle.ICON_LARGE or IconBundle.ICON_SMALL
> w | the width of the icon
> h | the height of the icon
> xform | any transformation to be applied to the icon
> align | any alignment to tbe applied to the icon
> pData | an array of ints which will hold the Java format ARGB data for the icon This must have at least w * h elements

### · getVolumeIcon | Summary | Top

       public abstract int getVolumeIcon(String driveName,
                                         int whichIcon,
                                         int w,
                                         int h,
                                         int xform,
                                         int align,
                                         int[] pData)

> Gets the icon for a volume
> WANC

> Parameter | Description
> driveName | the voluem
> whichIcon | either IconBundle.ICON_LARGE or IconBundle.ICON_SMALL
> w | the width of the icon
> h | the height of the icon
> xform | any transformation to be applied to the icon
> align | any alignment to tbe applied to the icon
> pData | an array of ints which will hold the Java format ARGB data for the icon This must have at least w * h elements

### · createVolumeAlias | Summary | Top

       public abstract int createVolumeAlias(String driveName,
                                             String newAliasPath,
                                             int flags)

> Create an alias to a volume
> WANC

> Parameter | Description
> driveName | the target
> newAliasPath | the full path to the new alias

### · createFileAlias | Summary | Top

       public abstract int createFileAlias(String targetPath,
                                           String newAliasPath,
                                           int flags)

> Create an alias to a file
> WANC

> Parameter | Description
> targetPath | full path of the target
> newAliasPath | the full path to the new alias

### · isLinkFile | Summary | Top

       public abstract boolean isLinkFile(File fl)

> Is 'fl' a symbolic link?

### · isDrivePath | Summary | Top

       public abstract boolean isDrivePath(File fl)

> Is 'fl' a volume?

### · pathToDriveName | Summary | Top

       public abstract String pathToDriveName(File fl)

> Returns the volume which contains 'fl', or null if that information can't be obtained.

### · isDriveString | Summary | Top

       public abstract boolean isDriveString(String drivePath)

> Is 'drivePath' a volume path, i.e., '/'?

### · getVolumes | Summary | Top

       public abstract int getVolumes(int maxToReturn,
                                      int[] numReturned,
                                      String[] driveNames)

> Retrieve a list of the mounted volumes.
> WANC

> Parameter | Description
> maxToReturn | the maximum number of volumes to return
> numReturned | on return, the first element will contain the number of volumes in 'driveNames'
> driveNames | on return, contains an array of Strings representing each drive. Must have at least 'maxToReturn' elements.

### · getVolumeLabel | Summary | Top

       public abstract int getVolumeLabel(String driveName,
                                          String[] label)

> Get the volume label

> Parameter | Description
> driveName | the drive name
> label | the drive label will be put at label[ 0 ]

### · getVolumeMaxFileNameLength | Summary | Top

       public abstract int getVolumeMaxFileNameLength(String driveName,
                                                      int[] nameLen)

> Get the maximum file name length of a volume.

> Parameter | Description
> driveName | the drive name
> nameLen | the name length will be placed at nameLen[ 0 ]

### · getVolumeReferenceNumber | Summary | Top

       public abstract int getVolumeReferenceNumber(String driveName,
                                                    int[] refNum)

> Get a platform-dependent number for a volume, such as a reference number.

> Parameter | Description
> driveName | the drive name
> nameLen | the reference number will be placed at refNum[ 0 ]

### · setVolumeLabel | Summary | Top

       public abstract int setVolumeLabel(String driveName,
                                          String newLabel)

> Sets the volume label of a drive
> WANC

> Parameter | Description
> driveName | the drive name
> newLabel | the new label

### · getDriveDisplayName | Summary | Top

       public abstract int getDriveDisplayName(String driveName,
                                               String[] displayName)

> Gets the display name of a drive. This is the name that would be displayed to the user.
> WANC

> Parameter | Description
> driveName | the drive name
> displayName | the display name will be placed at displayName[ 0 ]

### · getVolumeFlags | Summary | Top

       public abstract int getVolumeFlags(String driveName,
                                          int[] flags)

> Gets the flags for a volume. See DiskVolume for a description of the flags
> WANC

> Parameter | Description
> driveName | the drive name
> flags | the flags will be placed at flags[ 0 ]

### · getVolumeReadFlagsMask | Summary | Top

       public abstract int getVolumeReadFlagsMask(String driveName,
                                                  int[] flags)

> Gets the read flags for a volume. See DiskVolume for a description of this.
> WANC

> Parameter | Description
> driveName | the drive name
> flags | the flags will be placed at flags[ 0 ]

### · resolveLinkFile | Summary | Top

       public abstract int resolveLinkFile(String linkFilePath,
                                           String[] retPath,
                                           int flags)

> Resolves a symbolic link.
> WANC

> Parameter | Description
> linkFilePath | the full path of the .lnk file
> retPath | the resolved full path will be placed at retPath[ 0 ]
> flags | either kResolveLinkFileNoUI or kResolveLinkFileUI

### · getAllMonitorInfo | Summary | Top

       public abstract int getAllMonitorInfo(int[] monitorInfo,
                                             int maxToReturn,
                                             int[] numReturned)

> Gets information on all the user's monitors. Info on each monitor will be placed into the 'monitorInfo' int array. Each monitor consumes 'kMonitorInfoNumInts' elements of this array. The format of each monitor is as described in the 'getMainMonitorInfo' method.
> WANC

> Parameter | Description
> montitorInfo | must have at least 'maxToReturn' * kMonitorInfoNumInts elements.
> maxToReturn | the maximum number of monitors to return info on.
> numReturned | the number of monitors returned will be placed at numReturned[ 0 ]

### · getMainMonitorInfo | Summary | Top

       public abstract int getMainMonitorInfo(int[] monitorInfo)

> Stores information on the user's main monitor into the 'monitorInfo' array. This array must have at least 'kMonitorInfoNumInts' elements. The information on the monitor is stored at the 'kOffs???' offsets defined in 'MonitorMSVM.java':
> WANC

### · getExecutableType | Summary | Top

       public abstract int getExecutableType(String fullPath,
                                             int[] val)

> Gets the type of the given executable.
> WANC

> Parameter | Description
> fullPath | the full path of the executable
> val | the type will be placed at val[ 0 ], and will be one of the k???Exe values defined in 'AppFile.java': 'AF_W32', etc.

### · getFileAttributes | Summary | Top

       public abstract int getFileAttributes(String fullPath,
                                             int[] val)

> Gets the attributes of the given file.
> WANC

> Parameter | Description
> fullPath | the full path of the file
> val | the attributes will be placed at val[ 0 ], and will be one of the attributes defined in 'DiskFile.java': 'FILE_EXECUTABLE', 'FILE_DIR', etc.

### · getFileAttributesMask | Summary | Top

       public abstract int getFileAttributesMask(String fullPath,
                                                 int[] val)

> Indicates which bits of the value returned from getFileAttributes are valid. See that method for more information.
> WANC

> Parameter | Description
> fullPath | the full path of the file
> val | the mask will be placed at val[ 0 ]

### · launchApp | Summary | Top

       public abstract int launchApp(String appPath,
                                     String verb,
                                     String regKey,
                                     String commandLine,
                                     int[] retData,
                                     int numArgs,
                                     String[] args)

> Launches the given app with a set of arguments.

### · launchURL | Summary | Top

       public abstract int launchURL(String url,
                                     int flags,
                                     String[] preferredBrowsers)

> Launches the given URL.

> Parameter | Description
> url | the fully qualified URL
> flags | currently ignored
> preferredBrowsers | currently ignored

### · findAppsByName | Summary | Top

       public abstract String[] findAppsByName(String appName,
                                               int maxToReturn,
                                               int flags)

> Returns the full paths of the apps which match the given name.

> Parameter | Description
> appName | the string to search for.
> maxToReturn | indicates the maximum number of AppFiles to return. NOTE: this is used as a hint only; the actual array size may be greater or less than this.
> flags | the lower two bits of this int indicate the level of searching which should be performed. 0 indicates only standard searching; 1, 2, and 3 indicate increasingly full searching The remaining bits of this int are reserved, and should be set to zero.

### · findAppsByExtension | Summary | Top

       public abstract String[] findAppsByExtension(String ext,
                                                    int maxToReturn,
                                                    int flags)

> Returns the full paths of the apps which are used to launch files with the given extension

> Parameter | Description
> ext | the extension being searched for: ".txt"
> maxToReturn | the maximum number to return. This is a hint only.
> flags | reserved; set to 0

### · verifyNativeAppData | Summary | Top

       public abstract int verifyNativeAppData(int[] appData)

> Indicates if the given process is still running.
> WANC

### · quitApp | Summary | Top

       public abstract int quitApp(int[] appData,
                                   int flags)

> Quits the given process.
> WANC

> Parameter | Description
> appData | identifies the process
> flags | ignored; set to 0

### · moveApp | Summary | Top

       public abstract int moveApp(int[] appData,
                                   int selector,
                                   int flags)

> Moves the given process.
> WANC

> Parameter | Description
> appData | identifies the process
> selector | one of the 'APP_MOVE_TOFRONT', etc. constants defined in AppProcess.java
> flags | ignored; set to 0

    All Packages  This Package  Class Hierarchy  Class Search  Index

Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7