Chapter 8. Rexx Utilities (RexxUtil)

Table of Contents
A Note on Error Codes
List of Rexx Utility Functions
RxMessageBox (Windows only)
RxWinExec (Windows only)
SysAddRexxMacro
SysBootDrive (Windows only)
SysClearRexxMacroSpace
SysCloseEventSem
SysCloseMutexSem
SysCls
SysCreateEventSem
SysCreateMutexSem
SysCreatePipe (Unix only)
SysCurPos (Windows only)
SysCurState (Windows only)
SysDriveInfo (Windows only)
SysDriveMap (Windows only)
SysDropFuncs
SysDropRexxMacro
SysDumpVariables
SysFileCopy (Windows only)
SysFileDelete
SysFileExists
SysFileMove (Windows only)
SysFileSearch
SysFileSystemType (Windows only)
SysFileTree
SysFork (Unix only)
SysFromUnicode (Windows only)
SysGetErrortext
SysGetFileDateTime
SysGetKey
SysGetMessage (Unix only)
SysGetMessageX (Unix only)
SysIni (Windows only)
SysIsFile
SysIsFileCompressed (Windows only)
SysIsFileDirectory
SysIsFileEncrypted (Windows only)
SysIsFileLink
SysIsFileNotContentIndexed (Windows only)
SysIsFileOffline (Windows only)
SysIsFileSparse (Windows only)
SysIsFileTemporary (Windows only)
SysLinVer (Linux Only)
SysLoadFuncs
SysLoadRexxMacroSpace
SysMkDir
SysOpenEventSem
SysOpenMutexSem
SysPostEventSem
SysPulseEventSem (Windows only)
SysQueryProcess
SysQueryRexxMacro
SysReleaseMutexSem
SysReorderRexxMacro
SysRequestMutexSem
SysResetEventSem
SysRmDir
SysSaveRexxMacroSpace
SysSearchPath
SysSetFileDateTime
SysSetPriority
SysShutdownSystem (Windows only)
SysSleep
SysStemCopy
SysStemDelete
SysStemInsert
SysStemSort
SysSwitchSession (Windows only)
SysSystemDirectory (Windows only)
SysTempFileName
SysTextScreenRead (Windows only)
SysTextScreenSize (Windows only)
SysToUnicode (Windows only)
SysUtilVersion
SysVersion
SysVolumeLabel (Windows only)
SysWait (Unix only)
SysWaitEventSem
SysWaitNamedPipe (Windows only)
SysWinDecryptFile (Windows only)
SysWinEncryptFile (Windows only)
SysWinGetDefaultPrinter (Windows only)
SysWinGetPrinters (Windows only)
SysWinSetDefaultPrinter (Windows only)
SysWinVer Windows only)

RexxUtil is a Dynamic Link Library (DLL) package for Windows and *nix platforms; the package contains external Rexx functions. These functions:

All of the RexxUtil functions are registered by the ooRexx interpreter on startup so there is no need to register the functions either individually or via the SysLoadFuncs function.

A Note on Error Codes

On Windows, some of the REXXUTIL functions return operating system error codes on failure. The SysGetErrorText() function can be used retrieve a description of system error code. In addition, the meaning of these error return codes can be looked up in the Windows Operating System documentation provided by Microsoft.

The documentation is called the MSDN Library. The library is provided online for anyone to access. Pus, since May 2006, Microsoft has also provided the ISO images for the library free of charge. Anyone can download the ISOs, burn them to a CD, and install the library locally on their system.

The information below is provided to help the Rexx programmer locate the MSDN Library, if they would like to. All things on the Internet change. The URLs listed here are accurate at the time of this writing.

The online MSDN Library is currently located at:

http://msdn2.microsoft.com/en-us/library/default.aspx.

A direct link to the section on the System Error codes is:

http://msdn.microsoft.com/en-us/library/ms681381.aspx

A Google search of MSDN Library will turn up the section on the error codes. A Google search of MSDN "System Error Codes" will turn up the section on the error codes.

Directions to the downloadable ISO images of the MSDN Library have been posted on this blog entry:

http://blogs.msdn.com/robcaron/archive/2006/07/26/678897.aspx

A Google search using: "Rob Caron" General Downloads MSDN Library should also turn up the blog entry.