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

# XToolkit

  Wrappers for some API routines.

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

## Quick Index

  DESCRIPTION

## Class Summary

class XToolkit
{
public:

  static BOOL XGetDiskFreeSpace2( const CStr *csDriveName, unsigned __int64 *totalCapP, unsigned __int64 *totalFreeP, unsigned __int64 *userCapP, unsigned __int64 *userFreeP );
  static DWORD XGetDriveDisplayName( const CStr *csDriveName, DWORD dwFileAttributes, CStr *csDisplayName );
  static BOOL XGetVolumeInformation( const CStr *csDriveName, CStr *csOutVolName, LPDWORD lpVolumeSerialNumber, LPDWORD lpMaximumComponentLength, LPDWORD lpFileSystemFlags, CStr *csFileSystemName );
  static HIMAGELIST XSHGetFileInfoIcon( const CStr *csName, DWORD dwFileAttr, DWORD dwFlags, long *iconID );
  static BOOL XGetShortPathName( const CStr *fullPath, CStr *shortPath );
  static ErrCode XGetLogicalDriveStrings( CStr *toStr );
  static BOOL XCreateProcess( const CStr *commandLine, DWORD dwFlags, WORD wShowWindow, LPPROCESS_INFORMATION lpPI );
  static HINSTANCE XFindExecutable( const CStr *csDocFile, const CStr *csDirectory, CStr *csExeFullPath );
  static BOOL XGetDiskFreeSpace( const CStr *csDriveName, DWORD *sectorsPerClst, DWORD *bytesPerSector, DWORD *numFreeClst, DWORD *totNumClst );
  static DWORD XGetDriveType( const CStr *csDriveName );
  static HANDLE XFindFirstFileGetDates( const CStr *csSearchString, FILETIME *crDate, FILETIME *acDate, FILETIME *mdDate );
  static HANDLE XFindFirstFile( const CStr *csSearchString, DWORD *dwAttrs, CStr *csFileName );
  static BOOL XFindNextFile( HANDLE findH, DWORD *dwAttrs, CStr *csFileName );
  static DWORD XGetFileAttributes( const CStr *csFullPath );
  static ErrCode XGetFileAttributes2( const CStr *csFullPath, DWORD *attributes );
  static BOOL isGetFileAttributesExAvailable();
  static ErrCode XSetFileAttributes( const CStr *csFullPath, DWORD dwAttributes );
  static HINSTANCE XShellExecute( HWND hwnd, const CStr *csOp, const CStr *csFile, const CStr *csParams, const CStr *csDir, INT nShowCmd );
  static UINT XWinExec( const CStr *csCmdLine, UINT uCmdShow );
  static HSZ XDdeCreateStringHandle( DWORD idInst, const CStr *csStr, int iCodePage );
  static BOOL XDeleteFile( const CStr *csFullPath );
  static HANDLE XCreateFile( const CStr *csFileName, DWORD dwDesiredAccess, DWORD dwShareMode, LPSECURITY_ATTRIBUTES lpSecurityAttributes, DWORD dwCreationDistribution, DWORD dwFlagsAndAttributes, HANDLE hTemplateFile );
  static ErrCode XRegQueryValue( HKEY hKey, const CStr *csSubKey, CStr *csValue );
  static ErrCode XRegQueryValueEx( HKEY hKey, const CStr *csSubKey, CStr *csValue );
  static ErrCode XRegOpenKeyEx( HKEY hKey, const CStr *csSubKey, DWORD ulOptions, REGSAM samDesired, PHKEY phkResult );
  static ErrCode XRegEnumKey( HKEY hKey, DWORD dwIndex, CStr *csName );
  static DWORD XGetFileVersionInfoSize( const CStr *csFileName, LPDWORD lpdwHandle );
  static BOOL XGetFileVersionInfo( const CStr *csFileName, DWORD dwHandle, DWORD dwLen, LPVOID lpData );
  static BOOL XVerQueryValue( const LPVOID pBlock, const CStr *csSubBlock, LPVOID *lplpBuffer, PUINT puLen );
  static DWORD XSHGetFileInfoExeType( const CStr *fileName );
  static BOOL XSHGetPathFromIDList( LPCITEMIDLIST pidl, CStr *csLongFileName );

protected:

}; // XToolkit

Back to the top of XToolkit

### DESCRIPTION

Wraps some API routines, mainly to make them easier to use with CStr's. Most of these simply call the associated WinAPI routine, however some parameter validation is also performed.

Back to the top of XToolkit

### BOOL XGetDiskFreeSpace2( const CStr *csDriveName, unsigned __int64 *totalCapP, unsigned __int64 *totalFreeP, unsigned __int64 *userCapP, unsigned __int64 *userFreeP );

Calls GetDiskFreeSpaceEx() if it's available GetDiskFreeSpace() if not

out totalCapP
  will contain the total capacity of the volume
out totalFreeP
  will contain the total free space of the volume
out userCapP
  will contain the total capacity of the volume which is available to the current user
out userFreeP
  will contain the total free space of the volume which is available to the current user

    	static	BOOL		XGetDiskFreeSpace2( const CStr *csDriveName, unsigned __int64 *totalCapP,
    											unsigned __int64 *totalFreeP, unsigned __int64 *userCapP,
    											unsigned __int64 *userFreeP );

Back to the top of XToolkit

### DWORD XGetDriveDisplayName( const CStr *csDriveName, DWORD dwFileAttributes, CStr *csDisplayName );

Wraps GetDriveDisplayName()

    	static	DWORD		XGetDriveDisplayName( const CStr *csDriveName, DWORD dwFileAttributes, CStr *csDisplayName );

Back to the top of XToolkit

### BOOL XGetVolumeInformation( const CStr *csDriveName, CStr *csOutVolName, LPDWORD lpVolumeSerialNumber, LPDWORD lpMaximumComponentLength, LPDWORD lpFileSystemFlags, CStr *csFileSystemName );

Wraps GetVolumeInformation()

    	static	BOOL		XGetVolumeInformation( const CStr *csDriveName,
    												CStr *csOutVolName,
    												LPDWORD lpVolumeSerialNumber,
    												LPDWORD lpMaximumComponentLength,
    												LPDWORD lpFileSystemFlags,
    												CStr *csFileSystemName );

Back to the top of XToolkit

### HIMAGELIST XSHGetFileInfoIcon( const CStr *csName, DWORD dwFileAttr, DWORD dwFlags, long *iconID );

Wraps SHGetFileInfo() relating to getting the icon of a file.

    	static	HIMAGELIST	XSHGetFileInfoIcon( const CStr *csName, DWORD dwFileAttr, DWORD dwFlags, long *iconID );

Back to the top of XToolkit

### BOOL XGetShortPathName( const CStr *fullPath, CStr *shortPath );

Wraps GetShortPathName()

    	static	BOOL		XGetShortPathName( const CStr *fullPath, CStr *shortPath );

Back to the top of XToolkit

### ErrCode XGetLogicalDriveStrings( CStr *toStr );

Wraps GetLogicalDriveStrings()

    	static	ErrCode		XGetLogicalDriveStrings( CStr *toStr );

Back to the top of XToolkit

### BOOL XCreateProcess( const CStr *commandLine, DWORD dwFlags, WORD wShowWindow, LPPROCESS_INFORMATION lpPI );

Wraps CreateProcess()

    	static	BOOL		XCreateProcess( const CStr *commandLine, DWORD dwFlags, WORD wShowWindow,
    										LPPROCESS_INFORMATION lpPI );

Back to the top of XToolkit

### HINSTANCE XFindExecutable( const CStr *csDocFile, const CStr *csDirectory, CStr *csExeFullPath );

Wraps FindExecutable()

    	static	HINSTANCE	XFindExecutable( const CStr *csDocFile, const CStr *csDirectory, CStr *csExeFullPath );

Back to the top of XToolkit

### BOOL XGetDiskFreeSpace( const CStr *csDriveName, DWORD *sectorsPerClst, DWORD *bytesPerSector, DWORD *numFreeClst, DWORD *totNumClst );

Wraps GetDiskFreeSpace()

    	static	BOOL		XGetDiskFreeSpace( const CStr *csDriveName, DWORD *sectorsPerClst, DWORD *bytesPerSector,
    											DWORD *numFreeClst, DWORD *totNumClst );

Back to the top of XToolkit

### DWORD XGetDriveType( const CStr *csDriveName );

Wraps GetDriveType()

    	static	DWORD		XGetDriveType( const CStr *csDriveName );

Back to the top of XToolkit

### HANDLE XFindFirstFileGetDates( const CStr *csSearchString, FILETIME *crDate, FILETIME *acDate, FILETIME *mdDate );

Uses FindFirstFile() to get the dates for a file.

    	static	HANDLE		XFindFirstFileGetDates( const CStr *csSearchString, FILETIME *crDate, FILETIME *acDate, FILETIME *mdDate );

Back to the top of XToolkit

### HANDLE XFindFirstFile( const CStr *csSearchString, DWORD *dwAttrs, CStr *csFileName );

Wraps FindFirstFile()

    	static	HANDLE		XFindFirstFile( const CStr *csSearchString, DWORD *dwAttrs, CStr *csFileName );

Back to the top of XToolkit

### BOOL XFindNextFile( HANDLE findH, DWORD *dwAttrs, CStr *csFileName );

Wraps FindNextFile()

    	static	BOOL		XFindNextFile( HANDLE findH, DWORD *dwAttrs, CStr *csFileName );

Back to the top of XToolkit

### DWORD XGetFileAttributes( const CStr *csFullPath );

Wraps GetFileAttributes()

    	static	DWORD		XGetFileAttributes( const CStr *csFullPath );

Back to the top of XToolkit

### ErrCode XGetFileAttributes2( const CStr *csFullPath, DWORD *attributes );

Calls GetFileAttributesEx() if it's available, GetFileAttributes if not

out attributes
  contains the attributes if the return value is zero

    	static	ErrCode		XGetFileAttributes2( const CStr *csFullPath, DWORD *attributes );

Back to the top of XToolkit

### BOOL isGetFileAttributesExAvailable();

Indicates whether GetFileAttributesEx() is available

    	static	BOOL		isGetFileAttributesExAvailable();

Back to the top of XToolkit

### ErrCode XSetFileAttributes( const CStr *csFullPath, DWORD dwAttributes );

Wraps SetFileAttributes()

    	static	ErrCode		XSetFileAttributes( const CStr *csFullPath, DWORD dwAttributes );

Back to the top of XToolkit

### HINSTANCE XShellExecute( HWND hwnd, const CStr *csOp, const CStr *csFile, const CStr *csParams, const CStr *csDir, INT nShowCmd );

Wraps ShellExecute()

    	static	HINSTANCE	XShellExecute( HWND hwnd, const CStr *csOp, const CStr *csFile,
    										const CStr *csParams, const CStr *csDir, INT nShowCmd );

Back to the top of XToolkit

### UINT XWinExec( const CStr *csCmdLine, UINT uCmdShow );

Wraps WinExec()

    	static	UINT		XWinExec( const CStr *csCmdLine, UINT uCmdShow );

Back to the top of XToolkit

### HSZ XDdeCreateStringHandle( DWORD idInst, const CStr *csStr, int iCodePage );

Wraps DdeCreateStringHandle()

    	static	HSZ			XDdeCreateStringHandle( DWORD idInst, const CStr *csStr, int iCodePage );

Back to the top of XToolkit

### BOOL XDeleteFile( const CStr *csFullPath );

Wraps DeleteFile()

    	static	BOOL		XDeleteFile( const CStr *csFullPath );

Back to the top of XToolkit

### HANDLE XCreateFile( const CStr *csFileName, DWORD dwDesiredAccess, DWORD dwShareMode, LPSECURITY_ATTRIBUTES lpSecurityAttributes, DWORD dwCreationDistribution, DWORD dwFlagsAndAttributes, HANDLE hTemplateFile );

Wraps CreateFile()

    	static	HANDLE		XCreateFile( const CStr *csFileName, DWORD dwDesiredAccess, DWORD dwShareMode,
    								LPSECURITY_ATTRIBUTES lpSecurityAttributes, DWORD dwCreationDistribution,
    								DWORD dwFlagsAndAttributes, HANDLE hTemplateFile );

Back to the top of XToolkit

### ErrCode XRegQueryValue( HKEY hKey, const CStr *csSubKey, CStr *csValue );

Wraps RegQueryValue()

    	static	ErrCode		XRegQueryValue( HKEY hKey, const CStr *csSubKey, CStr *csValue );

Back to the top of XToolkit

### ErrCode XRegQueryValueEx( HKEY hKey, const CStr *csSubKey, CStr *csValue );

Wraps RegQueryValueEx()

    	static	ErrCode		XRegQueryValueEx( HKEY hKey, const CStr *csSubKey, CStr *csValue );

Back to the top of XToolkit

### ErrCode XRegOpenKeyEx( HKEY hKey, const CStr *csSubKey, DWORD ulOptions, REGSAM samDesired, PHKEY phkResult );

Wraps RegOpenKeyEx()

    	static	ErrCode		XRegOpenKeyEx( HKEY hKey, const CStr *csSubKey, DWORD ulOptions,
    										REGSAM samDesired, PHKEY phkResult );

Back to the top of XToolkit

### ErrCode XRegEnumKey( HKEY hKey, DWORD dwIndex, CStr *csName );

Wraps RegEnumKey()

    	static	ErrCode		XRegEnumKey( HKEY hKey, DWORD dwIndex, CStr *csName );

Back to the top of XToolkit

### DWORD XGetFileVersionInfoSize( const CStr *csFileName, LPDWORD lpdwHandle );

Wraps GetFileVersionInfoSize()

    	static	DWORD		XGetFileVersionInfoSize( const CStr *csFileName, LPDWORD lpdwHandle );

Back to the top of XToolkit

### BOOL XGetFileVersionInfo( const CStr *csFileName, DWORD dwHandle, DWORD dwLen, LPVOID lpData );

Wraps GetFileVersionInfo()

    	static	BOOL		XGetFileVersionInfo( const CStr *csFileName, DWORD dwHandle, DWORD dwLen, LPVOID lpData );

Back to the top of XToolkit

### BOOL XVerQueryValue( const LPVOID pBlock, const CStr *csSubBlock, LPVOID *lplpBuffer, PUINT puLen );

Wraps VerQueryValue()

    	static	BOOL		XVerQueryValue( const LPVOID pBlock, const CStr *csSubBlock, LPVOID *lplpBuffer, PUINT puLen );

Back to the top of XToolkit

### DWORD XSHGetFileInfoExeType( const CStr *fileName );

Wraps SHGetFileInfo() relating to getting the type of an executable

    	static	DWORD		XSHGetFileInfoExeType( const CStr *fileName );

Back to the top of XToolkit

### BOOL XSHGetPathFromIDList( LPCITEMIDLIST pidl, CStr *csLongFileName );

Wraps SHGetPathFromIDList()

    	static	BOOL		XSHGetPathFromIDList( LPCITEMIDLIST pidl, CStr *csLongFileName );

Back to the top of XToolkit

## All Members

public:
  static BOOL XGetDiskFreeSpace2( const CStr *csDriveName, unsigned __int64 *totalCapP, unsigned __int64 *totalFreeP, unsigned __int64 *userCapP, unsigned __int64 *userFreeP );
  static DWORD XGetDriveDisplayName( const CStr *csDriveName, DWORD dwFileAttributes, CStr *csDisplayName );
  static BOOL XGetVolumeInformation( const CStr *csDriveName, CStr *csOutVolName, LPDWORD lpVolumeSerialNumber, LPDWORD lpMaximumComponentLength, LPDWORD lpFileSystemFlags, CStr *csFileSystemName );
  static HIMAGELIST XSHGetFileInfoIcon( const CStr *csName, DWORD dwFileAttr, DWORD dwFlags, long *iconID );
  static BOOL XGetShortPathName( const CStr *fullPath, CStr *shortPath );
  static ErrCode XGetLogicalDriveStrings( CStr *toStr );
  static BOOL XCreateProcess( const CStr *commandLine, DWORD dwFlags, WORD wShowWindow, LPPROCESS_INFORMATION lpPI );
  static HINSTANCE XFindExecutable( const CStr *csDocFile, const CStr *csDirectory, CStr *csExeFullPath );
  static BOOL XGetDiskFreeSpace( const CStr *csDriveName, DWORD *sectorsPerClst, DWORD *bytesPerSector, DWORD *numFreeClst, DWORD *totNumClst );
  static DWORD XGetDriveType( const CStr *csDriveName );
  static HANDLE XFindFirstFileGetDates( const CStr *csSearchString, FILETIME *crDate, FILETIME *acDate, FILETIME *mdDate );
  static HANDLE XFindFirstFile( const CStr *csSearchString, DWORD *dwAttrs, CStr *csFileName );
  static BOOL XFindNextFile( HANDLE findH, DWORD *dwAttrs, CStr *csFileName );
  static DWORD XGetFileAttributes( const CStr *csFullPath );
  static ErrCode XGetFileAttributes2( const CStr *csFullPath, DWORD *attributes );
  static BOOL isGetFileAttributesExAvailable();
  static ErrCode XSetFileAttributes( const CStr *csFullPath, DWORD dwAttributes );
  static HINSTANCE XShellExecute( HWND hwnd, const CStr *csOp, const CStr *csFile, const CStr *csParams, const CStr *csDir, INT nShowCmd );
  static UINT XWinExec( const CStr *csCmdLine, UINT uCmdShow );
  static HSZ XDdeCreateStringHandle( DWORD idInst, const CStr *csStr, int iCodePage );
  static BOOL XDeleteFile( const CStr *csFullPath );
  static HANDLE XCreateFile( const CStr *csFileName, DWORD dwDesiredAccess, DWORD dwShareMode, LPSECURITY_ATTRIBUTES lpSecurityAttributes, DWORD dwCreationDistribution, DWORD dwFlagsAndAttributes, HANDLE hTemplateFile );
  static ErrCode XRegQueryValue( HKEY hKey, const CStr *csSubKey, CStr *csValue );
  static ErrCode XRegQueryValueEx( HKEY hKey, const CStr *csSubKey, CStr *csValue );
  static ErrCode XRegOpenKeyEx( HKEY hKey, const CStr *csSubKey, DWORD ulOptions, REGSAM samDesired, PHKEY phkResult );
  static ErrCode XRegEnumKey( HKEY hKey, DWORD dwIndex, CStr *csName );
  static DWORD XGetFileVersionInfoSize( const CStr *csFileName, LPDWORD lpdwHandle );
  static BOOL XGetFileVersionInfo( const CStr *csFileName, DWORD dwHandle, DWORD dwLen, LPVOID lpData );
  static BOOL XVerQueryValue( const LPVOID pBlock, const CStr *csSubBlock, LPVOID *lplpBuffer, PUINT puLen );
  static DWORD XSHGetFileInfoExeType( const CStr *fileName );
  static BOOL XSHGetPathFromIDList( LPCITEMIDLIST pidl, CStr *csLongFileName );
protected:

Back to the top of XToolkit

## Ancestors

Class does not inherit from any other class.

Back to the top of XToolkit

## Descendants

Class is not inherited by any others.

Back to the top of XToolkit

Generated from source by the Cocoon utilities on Fri Aug 23 12:34:10 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.