Main Page Cookbook/Overview ImageMeister the jcprops file Licensing Binary Installation & Configuration [ Win · Mac · Nix · OSX ] 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 · OSX ] Distribution Issues

# SVolumes

  Routines for working with volumes

[ Windows | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

## Quick Index

  DESCRIPTION

## Class Summary

class SVolumes
{
public:

  static ErrCode iSetVolumeLabel( const CStr *csDriveName, const CStr *newLabel );
  static ErrCode iGetVolumeInformation( const CStr *csDriveName, CStr *csOutVolName, CStr *csFileSystemName, unsigned long *theIntsP );
  static ErrCode iGetVolumeCapInfo( const CStr *csDriveName, unsigned __int64 *cap );
  static ErrCode iGetVolumeDates( const CStr *csDriveName, CDateBundle *dateBundle );
  static ErrCode iGetVolumeFlags( const CStr *csDriveName, long *flagsP );
  static ErrCode iGetVolumeReadFlagsMask( const CStr *csDriveName, long *maskP );
  static ErrCode iGetDriveDisplayName( const CStr *csDriveName, CStr *displayName );
  static ErrCode iGetVolumes( long maxToReturn, CStringVector *retStringTable );
  enum eVolumeCapInfo;
  enum eGVI;
  enum eDiskVolumeFlags;

protected:

}; // SVolumes

Back to the top of SVolumes

### DESCRIPTION

Routines for working with volumes

Back to the top of SVolumes

### ErrCode iSetVolumeLabel( const CStr *csDriveName, const CStr *newLabel );

Set the label of the given volume

in csDriveName
  The name of the volume.
in newLabel
  The new label.

    	static	ErrCode iSetVolumeLabel( const CStr *csDriveName, const CStr *newLabel );

Back to the top of SVolumes

### ErrCode iGetVolumeInformation( const CStr *csDriveName, CStr *csOutVolName, CStr *csFileSystemName, unsigned long *theIntsP );

Calls the WinAPI routine GetVolumeInformation() This routine returns two strings and three DWORDs, the strings are placed into 'csOutVolName' and 'csFileSystemName', and the DWORDs are placed into the 'theIntsP' array. See the enum eGVI for the length and offsets of the values in this buffer.

in csDriveName
  The name of the volume.
out csOutVolName
  The label of the volume
out csFileSystemName
  The name of the file system on the volume
out theIntsP
  Longs with info about the volume

    	static	ErrCode iGetVolumeInformation( const CStr *csDriveName, CStr *csOutVolName,
    										CStr *csFileSystemName, unsigned long *theIntsP );

Back to the top of SVolumes

### ErrCode iGetVolumeCapInfo( const CStr *csDriveName, unsigned __int64 *cap );

Returns the free space and capacity of a volume

in csDriveName
  The name of the volume.
out cap
  The free space and capacity of the volume will be placed at the offsets in cap given by the eVolumeCapInfo constants

    	static	ErrCode iGetVolumeCapInfo( const CStr *csDriveName, unsigned __int64 *cap );

Back to the top of SVolumes

### ErrCode iGetVolumeDates( const CStr *csDriveName, CDateBundle *dateBundle );

Retrieves the three dates associated with a volume, and puts them in the given CDateBundle

in csDriveName
  The name of the volume.
out dateBundle
  On exit, contains the three dates for the volume.

    	static	ErrCode iGetVolumeDates( const CStr *csDriveName, CDateBundle *dateBundle );

Back to the top of SVolumes

### ErrCode iGetVolumeFlags( const CStr *csDriveName, long *flagsP );

Gets flags on a volume

in csDriveName
  The name of the volume.
out flagsP
  The flags; see the 'kVolumeFlag...' constants

    	static	ErrCode iGetVolumeFlags( const CStr *csDriveName, long *flagsP );

Back to the top of SVolumes

### ErrCode iGetVolumeReadFlagsMask( const CStr *csDriveName, long *maskP );

Same

in csDriveName
  The name of the volume.
out maskP
  Returns which bits from iGetVolumeFlags are significant.

    	static	ErrCode iGetVolumeReadFlagsMask( const CStr *csDriveName, long *maskP );

Back to the top of SVolumes

### ErrCode iGetDriveDisplayName( const CStr *csDriveName, CStr *displayName );

Returns the display name of the volume.

in csDriveName
  The name of the volume.
out displayName
  The display name.

    	static	ErrCode iGetDriveDisplayName( const CStr *csDriveName, CStr *displayName );

Back to the top of SVolumes

### ErrCode iGetVolumes( long maxToReturn, CStringVector *retStringTable );

Sets a string vector with a list of the mounted volumes.

in maxToReturn
  The maximum number of volumes to return.
out retStringTable
  Each mounted volume will be appended to this vector

    	static	ErrCode iGetVolumes( long maxToReturn, CStringVector *retStringTable );

Back to the top of SVolumes

### enum eVolumeCapInfo;

The length of the buffer passed to iGetVolumeCapInfo, and the offset in this buffer of the system-wide capacity, system-wide free space, current-user-specific capacity, and current-user-specific free space

    	enum {
    		kVolumeCapInfoLen = 4,
    		kVolumeCapInfoCapacityOffset = 0,
    		kVolumeCapInfoFreeSpaceOffset = 1,
    		kVolumeCapInfoCapacityToUserOffset = 2,
    		kVolumeCapInfoFreeSpaceToUserOffset = 3
    	} eVolumeCapInfo;

Back to the top of SVolumes

### enum eGVI;

The length of the long buffers passed to iGetVolumeInformation, and the offsets in this buffer of the values returned from this routine.

    	enum {
    		kGVIIntArrayLen = 3,
    		kGVIIntSerialNumberOffset = 0,
    		kGVIIntMaxComponentLengthOffset = 1,
    		kGVIIntFileSystemFlagsOffset = 2
    	} eGVI;

Back to the top of SVolumes

### enum eDiskVolumeFlags;

Flags returned from iGetVolumeFlags

    	enum {
    		kVolumeFlagCaseIsPreserved = 0x01,
    		kVolumeFlagCaseSensitive = 0x02,
    		kVolumeFlagUnicodeSupported = 0x04,
    		kVolumeFlagFilesCompressed = 0x08,
    		kVolumeFlagVolumeCompressed = 0x10,
    		kVolumeFlagRemovable = 0x20,
    		kVolumeFlagFixed = 0x40,
    		kVolumeFlagRemote = 0x80,
    		kVolumeFlagCDROM = 0x100,
    		kVolumeFlagRAM = 0x200,
    		kVolumeFlagSystem = 0x400,
    		kVolumeFlagSupportedFlags = (
    					kVolumeFlagCaseIsPreserved | kVolumeFlagCaseSensitive | kVolumeFlagUnicodeSupported |
    					kVolumeFlagFilesCompressed | kVolumeFlagVolumeCompressed | kVolumeFlagRemovable |
    					kVolumeFlagFixed | kVolumeFlagRemote | kVolumeFlagCDROM | kVolumeFlagRAM | kVolumeFlagSystem )
    	} eDiskVolumeFlags;

Back to the top of SVolumes

## All Members

public:
  static ErrCode iSetVolumeLabel( const CStr *csDriveName, const CStr *newLabel );
  static ErrCode iGetVolumeInformation( const CStr *csDriveName, CStr *csOutVolName, CStr *csFileSystemName, unsigned long *theIntsP );
  static ErrCode iGetVolumeCapInfo( const CStr *csDriveName, unsigned __int64 *cap );
  static ErrCode iGetVolumeDates( const CStr *csDriveName, CDateBundle *dateBundle );
  static ErrCode iGetVolumeFlags( const CStr *csDriveName, long *flagsP );
  static ErrCode iGetVolumeReadFlagsMask( const CStr *csDriveName, long *maskP );
  static ErrCode iGetDriveDisplayName( const CStr *csDriveName, CStr *displayName );
  static ErrCode iGetVolumes( long maxToReturn, CStringVector *retStringTable );
  enum eVolumeCapInfo;
  enum eGVI;
  enum eDiskVolumeFlags;
protected:

Back to the top of SVolumes

## Ancestors

Class does not inherit from any other class.

Back to the top of SVolumes

## Descendants

Class is not inherited by any others.

Back to the top of SVolumes

Generated from source by the Cocoon utilities on Fri Aug 23 12:34:09 2002 .

Main Page · JConfig · ImageMeister · System Properties Repository · WordMeister · Free Samples · Java Freeware · Contact Us · FAQ · Links

Copyright (c) 1997-2002 Samizdat Productions. All Rights Reserved.
WarpMovie, TileMovie, JConfig, ImageMeister and MovieShredder are Trademarks of Samizdat Productions.