Check Communications Trace (QSCCHKCT) API


  Required Parameter Group:

1 Storage allocated Output Binary(8)
2 Storage in use Output Binary(8)
3 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Check Comunications Trace (QSCCHKCT) API returns, in bytes, the maximum size configured for the communications trace tool and the portion of that size that is currently in use for all communications traces active (running or stopped state), or zero if no traces are active.


Authorities and Locks

The caller must have *SERVICE special authority or must be authorized to the Service Trace function of the IBM® i operating system through System i™ Navigator's Application Administration support.


Required Parameter Group

Storage allocated
OUTPUT; Binary(8)

The variable containing the maximum bytes configured for the communications trace tool after the QSCCHKCT API has completed processing.

Storage in use
Output; Binary(8)

The variable containing the total bytes in use for all communications traces active (running or stopped state), or zero if no traces are active, after the QSCCHKCT API has completed processing.

Error Code
I/O; Char(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Error Messages

Message ID Error Message Text
CPF222E E &1 special authority is required.
CPF39A8 E Not authorized to communications trace service tool.
CPF39B6 E Communications trace function cannot be performed.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V5R2

[ Back to top | >Miscellaneous APIs | APIs by category ]