HPlogo SNA NRJE User/Programmer Reference Manual: HP 3000 MPE/iX Computer Systems > Chapter 6 NRJE Manager Intrinsics

NRJETrace

» 

Technical documentation

Complete book in PDF
» Feedback

 » Table of Contents

 » Glossary

 » Index

Initiates or terminates NRJE tracing.

Syntax

              BA       I         IA          I            I  
 NRJETrace ( Wsid, TraceOnOff, Traces, TraceFileLen, TraceMedium,  
                 I          BA         BA         IA        
             TraceSize, TraceFile, DefaultFile, Result ) 

Parameter

Wsid

An eight-character input byte array. The Wsid parameter identifies your workstation. It must contain a left-justified alphanumeric name beginning with a letter. If the workstation identifier is less than eight characters long, it must be followed by blanks.

TraceOnOff

An input integer. The TraceOnOff parameter indicates whether to initiate or terminate the tracing specified in Traces. Values are as follows:

  • 0 = Terminate the tracing.

  • 1 = Initiate the tracing.

Traces

A two-element input integer array. Each element of Traces contains an integer that represents a type of tracing to turn on or off.

The use of two elements allows you to enable multiple trace types simultaneously. The order of entry of the elements is not significant. Traces element values are as follows:

  • 0 = No trace.

  • 1 = NRJE LU process tracing.

    NOTE: Use this option only when recommended by your HP representative. This type of tracing can have a performance impact.

    If LU tracing is initiated, it must be done when the workstation is started. Thereafter, it can be stopped and restarted.

  • 2 = Intrinsic trace. Intrinsic tracing records the execution of NRJE intrinsics. All intrinsics are traced.

Following is an example of Traces for LU tracing only:

1
0

TraceFileLen

An input integer. The TraceFileLen parameter is the length in characters of the trace file designator, TraceFile.

The number of characters may be between one and thirty-five. If this parameter is zero, the trace is recorded in the DefaultFile.

TraceMedium

An input integer. TraceMedium indicates the TraceFile device type. This parameter is called by reference. The only valid value for TraceMedium is 0, which indicates that the trace information will be written to a disk file.

TraceSize

An input single-word integer. TraceSize contains the maximum number of logical records TraceFile is to contain, from 0 through 32767.

A logical record is 128 words long. If TraceSize is zero, the default size of 1024 records is used.

TraceFile

An input byte array. The TraceFile byte array contains an actual file designator used for trace output. This parameter is used only when TraceFileLen is greater than zero. This parameter identifies a disk trace output file. TraceFile can contain a fully qualified 35-character disk file name, with lockword, in this form:

     filename[lockword][groupname[acctname]]

The contents of TraceFile must be left-justified, with trailing blanks, and meet MPE standards for an actual file designator.

If you specify a disk file that does not exist (a NEW file), then it will be created as the destination for trace output.

If you specify an OLD file (it already exists), and it already is in use for trace output, then trace output records for this activity are interleaved with other trace output records. You minimize the use of disk space by using an OLD file appropriately; however, trace output can be overwritten. If you specify an OLD file that is not already open, the file will be overwritten with new trace data. No warning is issued. Trace file records are created after successful completion of the intrinsic. If an error is encountered during the execution of the intrinsic, only the status array will be traced.

DefaultFile

An output byte array. The DefaultFile parameter is the file designator of the default trace file. A default file name is created whenever TraceFileLen is zero.

Default file names are in the form NMTCnnnn.PUB.SYS, where nnnn is a four-digit number that is incremented each time a default trace is created. Default file names are up to 27 bytes long. The last character is always a blank. You can always retain trace data by using a DefaultFile; however, considerable disk space might be used.

Result

An eight-element integer output array (required). The Result array contains error codes that occurred during execution of this intrinsic.

The first element of the Result array is set to zero if no errors took place. The structure of the Result array is described in "Parameters Common to NRJE Intrinsics" in the introduction to Chapter 5 “User Intrinsics”

Always test the first element of Result immediately after you call this intrinsic. If the first element of Result is not zero, test the other elements of Result to determine the nature of the problem that has occurred.

Description

NRJETrace starts and stops NRJE tracing. Specify trace types and trace file characteristics in the input parameters. Tracing can also be initiated when a STARTWS or TRACEON command is issued, or when an NRJEStartWS or another NRJETrace intrinsic is called. If you set TraceFileLen to zero, then a default trace file, NMTCnnnn.PUB.SYS, is created and identified in DefaultFile. You can always retain trace data this way; however, considerable disk space might be used.

This intrinsic examines all input parameters when TraceOnOff=1, but it examines Traces only when TraceOnOff=0, which stops tracing. When NRJETrace returns control to your program, test the first element of Result.

Text Reference

TRACEON and TRACEOFF are NRJE subsystem commands that turn trace on and off. See the SNA NRJE Node Manager's Guide for more information on these commands.

NRJECONTROL TRACEON and NRJECONTROL TRACEOFF are MPE commands that turn trace on and off. Also see the SNA NRJE Node Manager's Guide for more information.

Feedback to webmaster