Caché ObjectScript Reference
Replacements for ObjectScript $ZUTIL Functions
 
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

Class methods and properties to replace $ZUTIL ($ZU) functions that are no longer documented.
Obsolete And Deprecated Functionality
Some $ZUTIL functionality is obsolete or deprecated. Beginning with version 2010.1 of Caché, documentation for legacy networking facilities DDP and DCP has been removed. The associated $ZUTIL functions are classed as deprecated; no replacement class methods or properties have been provided. This is also true for several other $ZUTIL functions because they no longer function as intended. Beginning with version 2010.2 of Caché, $ZUTIL(69,39) is also deprecated. The following $ZUTIL functions are not provided with equivalent replacements; the continued use of these $ZUTIL functions is discouraged:
$ZUTIL Function Description
67, 1, … Returns the activity state of a specified process, and resets.
68, 6, … Enables or disables reliable SET networking mode for the current process.
68, 27, … Sets or clears network hardening for the current process. Network hardening was only used by the obsolete DCP and DDP networks. It does not apply to ECP networks.
68,39, … Enables or disables caching for the current process.
68, 55, … Selects $X/$Y behavior for TCP devices for the current process.
69, 6, … Sets reliable SET networking mode system-wide.
69, 13, … Sets logging of asynchronous SET/KILL errors.
69, 14, … Sets logging of asynch errors to console.
69, 19, … Sets DDP password security system-wide.
69, 20, … Transfers global nodes with null subscripts with DSM-DDP.
69, 27, … Enables or disables network hardening system-wide.
69, 28, … Controls root-level (unsubscripted) global node kills system-wide.
69, 31, … Sets network locks handling system-wide following a DCP outage.
69, 35, … Sets silent retry for domainspace connection attempts system-wide.
69, 39, … Sets caching for future processes system-wide.
69, 55, … Selects $X/$Y behavior for TCP devices system-wide.
69, 67, … Suppresses or displays the stack and register usage message box system-wide.
78, 28, ... Returns journal directory block information.
90, 4, … Starts up in a specified namespace (UNIX/OpenVMS.
100 Determines which Windows operating system is running.
113 Reclaims routine and directory blocks.
130, … Sets or returns the domain ID or index.
133, … Maintains a set of metric counters.
$ZUTIL Function Replacements
Beginning with Caché version 2010.1, the Caché ObjectScript $ZUTIL functions are no longer documented. These functions remain available for use by applications as in prior releases, but the actions they perform are now also available by other means. The list of $ZUTIL functions, their description, and the new and preferred means of accomplishing the same objective are given here.
The following three tables list the $ZUTIL functions for which there are equivalent replacements.
Non-Configuration-Related Functions
$ZUTIL Function Description Class Property / Method
4, …
Terminates a Cache process.
5, …
Returns current namespace or switches to another namespace.
<Special variable>
$NAMESPACE is not an exact replacement for $ZUTIL(5); however, $NAMESPACE is almost always preferable, and existing use of $ZUTIL(5) should be phased out. $NAMESPACE provides full support for implied namespaces by establishing default mapping for system routines. $ZUTIL(5) handling of implied namespaces does not establish this default mapping.
9, …
Broadcasts a message to a specified device.
Write a message to the system console log, cconsole.log.
12, …
Converts file or directory name to canonical form.
15, …
Converts RMS filename to canonical form.
18, …
Sets undefined variable handling for the current process.
20, …
Specifies the namespace(s) that contains the routine dataset.
21, …
Returns the location of process-private globals.
21
Deletes all process-private globals.
22, 0, …
Specifies the form feed or backspace control code sequence.
28, …
Performs collation conversion.
39, …
Specifies a search path for percent (%) routines.
49, …
Obtains database information.
<various class properties>
53
Passes TCP device name to child process.
53, …
Returns TCP statistics.
55, …
Returns or changes the current language mode.
56, 2
Locates source file and line of code for last Cache ObjectScript error.
56, 6
Returns the operating system error code for a sequential file error.
62, …
Performs a syntax check of command line code.
67, 0, …
Returns the activity state of a specified process.
67, 4, …
Returns the process state.
67, 5, …
Returns the routine name of a specified process.
67, 6, …
Returns the namespace name for a specified process.
67, 7, …
Returns the device name for the specified process.
67, 8, …
Returns the number of lines executed by the specified process.
67, 9, …
Returns the number of global references made by the specified process.
67, 10, …
Returns the job type of the specified process.
67, 11, …
Returns the username of the owner of the specified process.
67, 12, …
Returns the name of the system for a client application.
67, 13, …
Returns the name of the executable for a client application.
67, 14, …
Formerly returned the operating system running a client application. Now returns the CSP Session ID.
67, 15, …
Returns the IP address of a client application.
71, …
Sets date to a fixed value for the current process.
78, 21
Searches journal file for open transactions.
78, 22, …
Returns journaling information.
<various class methods>
78, 23, …
Deletes a journal file.
78, 29
Flushes journal buffer.
82, 12, …
Redirects I/O operations.
86
Returns configuration file pathname and config name.
90, 10, …
Tests whether a namespace is defined.
94, …
Broadcasts a message to a specified process.
96, 3, …
Return error number for user-defined command.
96, 4, …
Sets $TEST to reflect I/O redirection.
96, 5, …
Sets the $DEVICE special variable.
<Special variable>
96, 9
Returns the calling routine name.
96, 10
Returns the calling routine database.
96, 14
Returns the current device type.
110
Returns the name of the system that is running.
114, …
Determines Ethernet address.
115, 11, …
Specifies whether a value can be inserted into an identity column.
128, 1
Returns location of last single step during debugging.
132
Makes the last device in use the principal I/O device.
140, 1, …
Returns file, directory, and disk information and performs file operations.
<various class methods>
140, 7, …
Returns a bitmap of file attributes.
147, …
Handles spaces in pathnames for the host platform.
158, 0
Returns number of currently installed printers.
158, 1
Lists currently installed printers.
168, …
Returns location of current working directory, or sets current working directory.
186, …
Sets display in programmer prompt for the current process.
188
Returns local date and time with fractional seconds system-wide.
<Function>
$NOW is not an exact replacement for $ZUTIL(188). $ZUTIL(188) returns current local time with fractional seconds, adjusted for local time variants such as Daylight Saving Time (DST). $NOW can return current local time with fractional seconds, but does not adjust for local time variants. $HOROLOG returns current local time adjusted for local time variants, but does not support fractional seconds.
189
Checks if TCP device is disconnected.
193, …
Converts Coordinated Universal Time (UTC) to local date and time (and vice versa).
<Function>
Process-Related Configuration Functions
$ZUTIL Function Description Class Method
68,0
Sets undefined variable handling for the current process.
68, 1, …
Enables or disables use of null subscripts for the current process.
68, 2, …
Sets sequential file open mode for the current process.
68, 3, …
Sets automatic sequential file creation option for the current process.
68, 5, …
Enables or disables processing of argumentless BREAK commands for the current process.
68, 7, …
Retains or strips extended global reference from globals returned to the current process.
68, 11, …
Enables or disables read line recall for the current process.
68, 15, …
Enables or disables I/O device disconnect detection for the current process.
68, 21, …
Sets synchronous commit mode for the current process.
68, 22, …
Sets handling of escape sequences when $X is updated for the current process.
68, 26, …
Sets namespace display in programmer prompt for the current process.
68, 28, …
Restricts or permits kills of root-level global nodes for the current process.
68, 30, …
Sets error handling behavior for the current process.
68, 32, …
Sets date range and invalid date behavior for the current process.
68, 34, …
Sets whether asynchronous errors can interrupt the current process.
68, 40, …
Sets sequential file end-of-file handling for the current process.
68, 42, …
Sets $JOB format for the current process.
68, 43, …
Sets clearing of global vectors for the current process.
68, 45, …
Sets truncation mode for string-to-number conversions for the current process.
68, 51, …
Sets whether or not changing namespaces changes operating system directories for the current process.
68, 60, …
Sets handling of asynchronous Telnet disconnect errors for the current process.
68, 63, …
Enables or disables the use of “e” as scientific notation symbol for the current process.
68, 66, …
Suppress Telnet NUL at end-of-line for the current process.
68, 67, …
Suppresses or displays the stack and register usage message box for the current process.
68, 70, …
Enables or disables $DOUBLE returning INF and NAN values for the current process.
68, 71, …
Sets IP address format for the current process.
68, 72, …
Sets MVBasic handling of undefined variables for the current process.
System-Related Configuration Functions
$ZUTIL Function Description Class Property
69, 0, …
Sets undefined variable default handling system-wide.
69, 1, …
Sets null subscript mode default system-wide.
69, 2, …
Sets sequential file open mode default system-wide.
69, 3, …
Sets automatic sequential file creation system-wide.
69, 5, …
Enables argumentless BREAK processing system-wide.
69, 7, …
Retains or strips extended global reference from globals system-wide.
69, 8, …
Sets ZA and ZD locking modes system-wide.
69, 10, …
Sets system behavior when journal is full.
69, 11, …
Sets Read Line Recall mode system-wide.
69, 15, …
Sets I/O device disconnect detection system-wide.
69, 21, …
Sets synchronous commit mode system-wide.
69, 22, …
Sets $X update mode for escape sequences system-wide.
69, 24, …
Sets $ZF process deletion behavior for OpenVMS STOP/ID system-wide.
69, 26, …
Sets namespace display in programmer prompt system-wide.
69, 30, …
Sets error handling behavior system-wide.
69, 32, …
Sets date range and invalid date behavior system-wide.
69, 34, …
Sets interruptability of processes by asynchronous errors system-wide.
69, 37, …
Sets physical cursor mode system-wide.
69, 40, …
Sets end-of-file handling for sequential files system-wide.
69, 42, …
Sets $JOB format default system-wide.
69, 43, …
Sets clearing of global vectors system-wide.
69, 44, …
Sets use of the Nagle algorithm for Telnet transmissions system-wide.
69, 45, …
Truncates numbers during string-to-number conversion system-wide.
69, 49, …
Sets logging of transaction rollbacks system-wide.
69, 51, …
Sets namespace default directory assignment behavior system-wide.
69, 60, …
Sets handling of asynchronous Telnet disconnect errors system-wide.
69, 63, …
Enables or disables lowercase “e” as scientific notation symbol system-wide.
69, 66, …
Suppress Telnet NUL at end-of-line system-wide.
69, 68, …
Enables or disables the encryption of journal files system-wide.
69, 69, …
Enables or disables the use of long strings system-wide.
69, 70, …
Enables or disables $DOUBLE returning INF and NAN values system-wide.
69, 71, …
Sets IP address format system-wide.
69, 72, …
Sets MVBasic handling of undefined variables system-wide.
Note:
The $ZUTIL function descriptions excised from this reference have been removed to their own book. It can be found in the Legacy Documentation archive as Caché ObjectScript $ZUTIL Reference, Version 2010.1. There are no plans to update this legacy volume.