Jump to content

REXX Utility Functions: Difference between revisions

From EDM2
Ak120 (talk | contribs)
Created page with "REXX Utility Functions {|class="wikitable" !Function||OS/2||Windows||UNIX||Remarks |- |SysAddFileHandle||Y||Y||N|| |- |SysAddRexxMacro||Y||Y||Y|| |- |SysBootDrive||Y||Y||N|| ..."
 
Ak120 (talk | contribs)
mNo edit summary
 
(8 intermediate revisions by the same user not shown)
Line 2: Line 2:


{|class="wikitable"
{|class="wikitable"
!Function||OS/2||Windows||UNIX||Remarks
!Function||OS/2||Windows||UNIX|| ||Remarks
|-
|-
|SysAddFileHandle||Y||Y||N||
|SysAddFileHandle||Y||Y|| ||Adds to the number of file handles available to the current process.||
|-
|-
|SysAddRexxMacro||Y||Y||Y||
|SysAddRexxMacro||Y||Y||Y||Adds a routine to the REXX macrospace.||
|-
|-
|SysBootDrive||Y||Y||N||
|SysBootDrive||Y||Y|| ||Returns the drive used to boot the operating system.||
|-
|-
|SysClearRexxMacroSpace||Y||Y||Y||
|SysClearRexxMacroSpace||Y||Y||Y||Clears the REXX macrospace.||
|-
|-
|SysCloseEventSem||Y||Y||Y||
|SysCloseEventSem||Y||Y||Y||Closes an event semaphore.||
|-
|-
|SysCloseMutexSem||Y||Y||Y||
|SysCloseMutexSem||Y||Y||Y||Closes a mutex semaphore.||
|-
|-
|SysCls||Y||Y||Y||
|SysCls||Y||Y||Y||Clears the screen.||
|-
|-
|SysCopyObject||Y|| || ||
|SysCopyObject||Y|| || ||Copies an existing Workplace Shell object to the specified destination folder.||''Warp 3''
|-
|-
|SysCreateEventSem||Y||Y||Y||
|SysCreateEventSem||Y||Y||Y||Creates or opens an event semaphore.||
|-
|-
|SysCreateMutexSem||Y||Y||Y||
|SysCreateMutexSem||Y||Y||Y||Creates or opens an OS/2 mutex semaphore.||
|-
|-
|SysCreateObject||Y|| || ||
|SysCreateObject||Y|| || ||Creates a new instance of an object class.||
|-
|-
|SysCreatePipe|| || ||Y||
|SysCreatePipe|| || ||Y||Creates an unnamed pipe.||
|-
|-
|SysCreateShadow||Y|| || ||
|SysCreateShadow||Y|| || ||Shadows an existing Workplace Shell object to the specified destination folder.||''Warp 3''
|-
|-
|SysCurPos||Y||Y||N||
|SysCurPos||Y||Y|| ||Returns the cursor position and optionally moves the cursor to a new location.||
|-
|-
|SysCurState||Y||Y||N||
|SysCurState||Y||Y|| ||Hides or displays the cursor.||
|-
|-
|SysDeregisterObjectClass||Y|| || ||
|SysDeregisterObjectClass||Y|| || ||Deregisters an object class definition from the system.||
|-
|-
|SysDestroyObject||Y|| || ||
|SysDestroyObject||Y|| || ||Destroys an existing Workplace Shell object.||
|-
|-
|SysDriveInfo||Y||Y||N||
|SysDriveInfo||Y||Y|| ||Returns drive information.||
|-
|-
|SysDriveMap||Y||Y||N||
|SysDriveMap||Y||Y|| ||Returns a string listing accessible drives (separated by blanks).||
|-
|-
|SysDropFuncs||Y||Y||Y||
|SysDropFuncs||Y||Y||Y||Drops all RexxUtil functions.||
|-
|-
|SysDropLibrary||Y||Y|| ||
|SysDropLibrary||Y||Y|| ||Drops REXX external function library.||
|-
|-
|SysDropRexxMacro||Y||Y||Y||
|SysDropRexxMacro||Y||Y||Y||Removes a routine from the REXX macrospace.||
|-
|-
|SysDumpVariables||Y||Y||Y||
|SysDumpVariables||Y||Y||Y||Dumps all variables in the current scope.||(18 May 1999)
|-
|-
|SysElapsedTime||Y|| || ||
|SysElapsedTime||Y|| || ||Returns a time in the format: sssssssss.uuuuuu.||
|-
|-
|SysFileDelete||Y||Y||Y||
|SysFileDelete||Y||Y||Y||Deletes a file.||
|-
|-
|SysFileSearch||Y||Y||Y||
|SysFileSearch||Y||Y||Y||Finds all file lines containing the target string.||
|-
|-
|SysFileSystemType||Y||Y|| ||
|SysFileSystemType||Y||Y|| ||Returns the name of the file system used for a drive.||
|-
|-
|SysFileTree||Y||Y||Y*||
|SysFileTree||Y||Y||Y*||Finds all files that match a file specification.||
|-
|-
|SysFromUnicode|| ||Y|| ||
|SysFork|| || ||Y||Returns the process id to the parent process.||
|-
|-
|SysToUnicode|| ||Y|| ||
|SysFromUnicode|| ||Y|| ||Maps a UniCode character string to an ASCII character string.||
|-
|-
|SysGetErrortext||N||Y||Y**||
|SysGetCollate||Y||Y|| ||Retrieves the country-specific collating table.||
|-
|-
|SysFork|| || ||Y||
|SysGetEA||Y|| || ||Retrieves a file's extended attribute and stores its value in variable.||
|-
|-
|SysGetCollate||Y||Y|| ||
|SysGetErrortext|| ||Y||Y**||Obtains a string describing the system error identified by the error number.||
|-
|-
|SysGetEA||Y|| || ||
|SysGetFileDateTime||Y||Y||Y||Returns the selected data and time attribute of a file.||(18 May 1999)
|-
|-
|SysGetFileDateTime||Y||Y||Y||
|SysGetKey||Y||Y||Y||Reads and returns the next key from the keyboard buffer.||
|-
|-
|SysGetKey||Y||Y||Y||
|SysGetMessage||Y||Y|| ||Retrieves a message from an operating system message file.||
|-
|-
|SysGetMessage|| ||Y||Y||
|SysGetMessageX|| || ||Y||Retrieves a message from a specific set of Unix catalog file.||
|-
|-
|SysGetMessageX|| || ||Y||
|SysGetpid|| || ||Y+|| ||use SysQueryProcess instead
|-
|-
|SysGetpid|| || ||Y+||useSysQueryProcessinstead;
|SysIni||Y||Y|| ||Allows limited access to INI file variables.||
|-
|-
|SysIni||Y||Y|| ||
|SysLinVer|| || ||Y||Returns a string identifying the Linux system version.||use SysVersion instead
|-
|-
|SysLoadFuncs||Y||Y||Y||
|SysLoadFuncs||Y||Y||Y||Loads all RexxUtil functions.||
|-
|-
|SysLoadLibrary||Y||Y|| ||
|SysLoadLibrary||Y||Y|| ||Loads REXX external function library.||
|-
|-
|SysLoadRexxMacroSpace||Y||Y||Y||
|SysLoadRexxMacroSpace||Y||Y||Y||Loads functions from a saved macrospace file.||
|-
|-
|SysMapCase||Y||Y|| ||
|SysMapCase||Y||Y|| ||Performs a national language uppercase mapping to a string.||
|-
|-
|SysMkDir||Y||Y||Y||
|SysMkDir||Y||Y||Y||Creates a specified directory quickly.||
|-
|-
|SysMoveObject||Y|| || ||
|SysMoveObject||Y|| || ||Moves an existing Workplace Shell object to the specified destination folder.||''Warp 3''
|-
|-
|SysNationalLanguageCompare||Y||Y|| ||
|SysNationalLanguageCompare||Y||Y|| ||Compares two character strings using a country-specific collating table.||
|-
|-
|SysOpenEventSem||Y||Y||Y||
|SysOpenEventSem||Y||Y||Y||Opens an event semaphore.||
|-
|-
|SysOpenMutexSem||Y||Y||Y||
|SysOpenMutexSem||Y||Y||Y||Opens an mutex semaphore.||
|-
|-
|SysOpenObject||Y|| || ||
|SysOpenObject||Y|| || ||Opens a view of an existing Workplace Shell object.||''Warp 3''
|-
|-
|SysPostEventSem||Y||Y||Y||
|SysOS2Ver||Y|| || ||Returns a string specifying the OS/2 operating system version information.||use SysVersion instead
|-
|-
|SysProzessType||Y||Y|| ||
|SysPostEventSem||Y||Y||Y||Posts an event semaphore.||
|-
|-
|SysPulseEventSem||Y||Y|| ||
|SysProcessType||Y||Y|| ||Returns the type of process in which the REXX program is running.||
|-
|-
|SysPutEA||Y|| || ||
|SysPulseEventSem||Y||Y|| ||Posts and immediately resets an event semaphore.||
|-
|-
|SysQueryClassList||Y|| || ||
|SysPutEA||Y|| || ||Writes a named extended attribute to a file.||
|-
|-
|SysQueryEAList||Y|| || ||
|SysQueryClassList||Y|| || ||Retrieves the complete list of registered object classes.||
|-
|-
|SysQueryExtLIBPATH||Y|| || ||
|SysQueryEAList||Y|| || ||Retrieves the complete list of extended attribute names.||
|-
|-
|SysQueryProcess||Y||Y||Y*||
|SysQueryExtLIBPATH||Y|| || ||Returns the current path to be searched before or after the system LIBPATH.||(11 Nov 1997)
|-
|-
|SysQueryProcessCodePage||Y||Y|| ||
|SysQueryProcess||Y||Y||Y*||Retrieves information about the current process.||
|-
|-
|SysQueryRexxMacro||Y||Y||Y||
|SysQueryProcessCodePage||Y||Y|| ||Queries the current code page for the process.||
|-
|-
|SysQuerySwitchList||Y|| || ||
|SysQueryRexxMacro||Y||Y||Y||Queries the existence of a macrospace function.||
|-
|-
|SysRegisterObjectClass||Y|| || ||
|SysQuerySwitchList||Y|| || ||Obtains information about the entries in the Window List.||(11 Nov 1997)
|-
|-
|SysReleaseMutexSem||Y||Y||Y||
|SysRegisterObjectClass||Y|| || ||Registers a new object class definition.||
|-
|-
|SysReorderRexxMacro||Y||Y||Y||
|SysReleaseMutexSem||Y||Y||Y||Releases a mutex semaphore.||
|-
|-
|SysRequestMutexSem||Y||Y||Y||
|SysReorderRexxMacro||Y||Y||Y||Reorders a routine loaded in the REXX macrospace.||
|-
|-
|SysResetEventSem||Y||Y||Y||
|SysRequestMutexSem||Y||Y||Y||Requests a mutex semaphore.||
|-
|-
|SysRmDir||Y||Y||Y||
|SysResetEventSem||Y||Y||Y||Resets an event semaphore.||
|-
|-
|SysSaveObject||Y|| || ||
|SysRmDir||Y||Y||Y||Deletes a specified file directory quickly.||
|-
|-
|SysSaveRexxMacroSpace||Y||Y||Y||
|SysSaveObject||Y|| || ||Saves an existing Workplace Shell object.||''Warp 3''
|-
|-
|SysSearchPath||Y||Y||Y||
|SysSaveRexxMacroSpace||Y||Y||Y||Saves the REXX macrospace.||
|-
|-
|SysSetExtLIBPATH||Y|| || ||
|SysSearchPath||Y||Y||Y||Searches the specified file path for the specified file.||
|-
|-
|SysSetFileDateTime||Y||Y||Y||
|SysSetExtLIBPATH||Y|| || ||Defines the current path to be searched before or after the system LIBPATH.||(11 Nov 1997)
|-
|-
|SysSetFileHandle||Y|| || ||
|SysSetFileDateTime||Y||Y||Y||Modifies the "Last Modified" date and time of file.||(18 May 1999)
|-
|-
|SysSetIcon||Y|| || ||
|SysSetFileHandle||Y|| || ||Sets the number of file handles available to the current process.||
|-
|-
|SysSetObjectData||Y|| || ||
|SysSetIcon||Y|| || ||Associates an icon file with a specified file.||
|-
|-
|SysSetPriority||Y||Y|| ||
|SysSetObjectData||Y|| || ||Changes the settings of an existing object.||
|-
|-
|SysSetProcessCodePage||Y||Y|| ||
|SysSetPriority||Y||Y|| ||Changes the priority of the current process.||
|-
|-
|SysShutDownSystem||Y||Y|| ||
|SysSetProcessCodePage||Y||Y|| ||Changes the current code page for the process.||
|-
|-
|SysSleep||Y||Y||Y||
|SysShutDownSystem||Y||Y|| ||Shuts down the operating system.||
|-
|-
|SysStemCopy||Y||Y||Y||
|SysSleep||Y||Y||Y||Pauses a REXX program for a specified time interval.||
|-
|-
|SysStemDelete||Y||Y||Y||
|SysStemCopy||Y||Y||Y||Copies items from the source stem to the target stem.||(18 May 1999)
|-
|-
|SysStemInsert||Y||Y||Y||
|SysStemDelete||Y||Y||Y||Deletes the specified item at the index startitem in the stem.||(18 May 1999)
|-
|-
|SysStemSort||Y||Y||Y||
|SysStemInsert||Y||Y||Y||Inserts a new item at position in the stem.||(18 May 1999)
|-
|-
|SysSwitchSession||Y||Y|| ||
|SysStemSort||Y||Y||Y||Sorts all or the specified items in the stem.||(18 May 1999)
|-
|-
|SysSystemDirectory||Y|| || ||
|SysSwitchSession||Y||Y|| ||Brings the named window to the foreground.||(11 Nov 1997)
|-
|-
|SysTempFileName||Y||Y||Y||
|SysSystemDirectory|| ||Y|| ||Returns the Windows system directory.||
|-
|-
|SysTextScreenRead||Y||Y|| ||
|SysTempFileName||Y||Y||Y||Returns a unique file or directory name for a file or directory that does not currently exist.||
|-
|-
|SysTextScreenSize||Y||Y|| ||
|SysTextScreenRead||Y||Y|| ||Reads characters from a specified screen location.||
|-
|-
|SysUtilVersion||Y||Y||Y||
|SysTextScreenSize||Y||Y|| ||Returns the size of the screen.||
|-
|-
|SysVersion||Y||Y||Y||
|SysToUnicode|| ||Y|| ||Maps a character string to a UniCode string.||
|-
|-
|SysVolumeLabel||Y||Y|| ||
|SysUtilVersion||Y||Y||Y||Returns a version number that identifies the current level of the Rexx Utilities package.||(18 May 1999)
|-
|-
|SysWait|| || ||Y||
|SysVersion||Y||Y||Y||Returns a string to identify the operating system and version.||(18 May 1999)
|-
|-
|SysWaitEventSem||Y||Y||Y||
|SysVolumeLabel||Y||Y|| ||Returns the volume label for the specified drive.||
|-
|-
|SysWaitForShell||Y|| || ||
|SysWait|| || ||Y||Waits for all child processes to end.||
|-
|-
|SysWaitNamedPipe||Y||Y|| ||
|SysWaitEventSem||Y||Y||Y||Waits on an event semaphore.||
|-
|-
|SysWinDecryptFile|| ||Y|| ||
|SysWaitForShell||Y|| || ||Wait for a specific initialization event of the Workplace Shell.||
|-
|-
|SysWinEncryptFile|| ||Y|| ||
|SysWaitNamedPipe||Y||Y|| ||Performs a timed wait on a named pipe.||
|-
|-
|SysWildCard||Y||Y|| ||
|SysWildCard||Y||Y|| ||Produces an edited file name using a source file name and a wild card editing pattern.||
|-
|SysWinDecryptFile|| ||Y|| ||Decrypts a given file.||
|-
|SysWinEncryptFile|| ||Y|| ||Encrypts a given file.||
|-
|SysWinVer|| ||Y|| ||Returns a string specifying the Windows operating system version information.||use SysVersion instead
|}
|}
SysOS2Ver||Y|| || ||useSysVersioninstead;
 
SysWinVer|| ||Y|| ||useSysVersioninstead;
[[Category:REXX Function Library]]
SysLinVer|NO|NO|YES++|useSysVersioninstead;

Latest revision as of 23:24, 20 September 2021

REXX Utility Functions

Function OS/2 Windows UNIX Remarks
SysAddFileHandle Y Y Adds to the number of file handles available to the current process.
SysAddRexxMacro Y Y Y Adds a routine to the REXX macrospace.
SysBootDrive Y Y Returns the drive used to boot the operating system.
SysClearRexxMacroSpace Y Y Y Clears the REXX macrospace.
SysCloseEventSem Y Y Y Closes an event semaphore.
SysCloseMutexSem Y Y Y Closes a mutex semaphore.
SysCls Y Y Y Clears the screen.
SysCopyObject Y Copies an existing Workplace Shell object to the specified destination folder. Warp 3
SysCreateEventSem Y Y Y Creates or opens an event semaphore.
SysCreateMutexSem Y Y Y Creates or opens an OS/2 mutex semaphore.
SysCreateObject Y Creates a new instance of an object class.
SysCreatePipe Y Creates an unnamed pipe.
SysCreateShadow Y Shadows an existing Workplace Shell object to the specified destination folder. Warp 3
SysCurPos Y Y Returns the cursor position and optionally moves the cursor to a new location.
SysCurState Y Y Hides or displays the cursor.
SysDeregisterObjectClass Y Deregisters an object class definition from the system.
SysDestroyObject Y Destroys an existing Workplace Shell object.
SysDriveInfo Y Y Returns drive information.
SysDriveMap Y Y Returns a string listing accessible drives (separated by blanks).
SysDropFuncs Y Y Y Drops all RexxUtil functions.
SysDropLibrary Y Y Drops REXX external function library.
SysDropRexxMacro Y Y Y Removes a routine from the REXX macrospace.
SysDumpVariables Y Y Y Dumps all variables in the current scope. (18 May 1999)
SysElapsedTime Y Returns a time in the format: sssssssss.uuuuuu.
SysFileDelete Y Y Y Deletes a file.
SysFileSearch Y Y Y Finds all file lines containing the target string.
SysFileSystemType Y Y Returns the name of the file system used for a drive.
SysFileTree Y Y Y* Finds all files that match a file specification.
SysFork Y Returns the process id to the parent process.
SysFromUnicode Y Maps a UniCode character string to an ASCII character string.
SysGetCollate Y Y Retrieves the country-specific collating table.
SysGetEA Y Retrieves a file's extended attribute and stores its value in variable.
SysGetErrortext Y Y** Obtains a string describing the system error identified by the error number.
SysGetFileDateTime Y Y Y Returns the selected data and time attribute of a file. (18 May 1999)
SysGetKey Y Y Y Reads and returns the next key from the keyboard buffer.
SysGetMessage Y Y Retrieves a message from an operating system message file.
SysGetMessageX Y Retrieves a message from a specific set of Unix catalog file.
SysGetpid Y+ use SysQueryProcess instead
SysIni Y Y Allows limited access to INI file variables.
SysLinVer Y Returns a string identifying the Linux system version. use SysVersion instead
SysLoadFuncs Y Y Y Loads all RexxUtil functions.
SysLoadLibrary Y Y Loads REXX external function library.
SysLoadRexxMacroSpace Y Y Y Loads functions from a saved macrospace file.
SysMapCase Y Y Performs a national language uppercase mapping to a string.
SysMkDir Y Y Y Creates a specified directory quickly.
SysMoveObject Y Moves an existing Workplace Shell object to the specified destination folder. Warp 3
SysNationalLanguageCompare Y Y Compares two character strings using a country-specific collating table.
SysOpenEventSem Y Y Y Opens an event semaphore.
SysOpenMutexSem Y Y Y Opens an mutex semaphore.
SysOpenObject Y Opens a view of an existing Workplace Shell object. Warp 3
SysOS2Ver Y Returns a string specifying the OS/2 operating system version information. use SysVersion instead
SysPostEventSem Y Y Y Posts an event semaphore.
SysProcessType Y Y Returns the type of process in which the REXX program is running.
SysPulseEventSem Y Y Posts and immediately resets an event semaphore.
SysPutEA Y Writes a named extended attribute to a file.
SysQueryClassList Y Retrieves the complete list of registered object classes.
SysQueryEAList Y Retrieves the complete list of extended attribute names.
SysQueryExtLIBPATH Y Returns the current path to be searched before or after the system LIBPATH. (11 Nov 1997)
SysQueryProcess Y Y Y* Retrieves information about the current process.
SysQueryProcessCodePage Y Y Queries the current code page for the process.
SysQueryRexxMacro Y Y Y Queries the existence of a macrospace function.
SysQuerySwitchList Y Obtains information about the entries in the Window List. (11 Nov 1997)
SysRegisterObjectClass Y Registers a new object class definition.
SysReleaseMutexSem Y Y Y Releases a mutex semaphore.
SysReorderRexxMacro Y Y Y Reorders a routine loaded in the REXX macrospace.
SysRequestMutexSem Y Y Y Requests a mutex semaphore.
SysResetEventSem Y Y Y Resets an event semaphore.
SysRmDir Y Y Y Deletes a specified file directory quickly.
SysSaveObject Y Saves an existing Workplace Shell object. Warp 3
SysSaveRexxMacroSpace Y Y Y Saves the REXX macrospace.
SysSearchPath Y Y Y Searches the specified file path for the specified file.
SysSetExtLIBPATH Y Defines the current path to be searched before or after the system LIBPATH. (11 Nov 1997)
SysSetFileDateTime Y Y Y Modifies the "Last Modified" date and time of file. (18 May 1999)
SysSetFileHandle Y Sets the number of file handles available to the current process.
SysSetIcon Y Associates an icon file with a specified file.
SysSetObjectData Y Changes the settings of an existing object.
SysSetPriority Y Y Changes the priority of the current process.
SysSetProcessCodePage Y Y Changes the current code page for the process.
SysShutDownSystem Y Y Shuts down the operating system.
SysSleep Y Y Y Pauses a REXX program for a specified time interval.
SysStemCopy Y Y Y Copies items from the source stem to the target stem. (18 May 1999)
SysStemDelete Y Y Y Deletes the specified item at the index startitem in the stem. (18 May 1999)
SysStemInsert Y Y Y Inserts a new item at position in the stem. (18 May 1999)
SysStemSort Y Y Y Sorts all or the specified items in the stem. (18 May 1999)
SysSwitchSession Y Y Brings the named window to the foreground. (11 Nov 1997)
SysSystemDirectory Y Returns the Windows system directory.
SysTempFileName Y Y Y Returns a unique file or directory name for a file or directory that does not currently exist.
SysTextScreenRead Y Y Reads characters from a specified screen location.
SysTextScreenSize Y Y Returns the size of the screen.
SysToUnicode Y Maps a character string to a UniCode string.
SysUtilVersion Y Y Y Returns a version number that identifies the current level of the Rexx Utilities package. (18 May 1999)
SysVersion Y Y Y Returns a string to identify the operating system and version. (18 May 1999)
SysVolumeLabel Y Y Returns the volume label for the specified drive.
SysWait Y Waits for all child processes to end.
SysWaitEventSem Y Y Y Waits on an event semaphore.
SysWaitForShell Y Wait for a specific initialization event of the Workplace Shell.
SysWaitNamedPipe Y Y Performs a timed wait on a named pipe.
SysWildCard Y Y Produces an edited file name using a source file name and a wild card editing pattern.
SysWinDecryptFile Y Decrypts a given file.
SysWinEncryptFile Y Encrypts a given file.
SysWinVer Y Returns a string specifying the Windows operating system version information. use SysVersion instead