logUserCommand

Product Information > JADE Object Manager Guide > Chapter 4 - JADE System Instrumentation and Diagnosis > logUserCommand

logUserCommand

logUserCommand(samplingHandle: Integer;
               command:        String;
               userNumber:     Integer;
               userText:       String);

The logUserCommand method of the System class causes the invocation of the NodeSampleUserCommandCallBack entry point in the user library for each of the nodes in the sample definition group, passing the command parameter to it.

The logUserCommand method parameters are listed in the following table.

Parameter	Description
samplingHandle	Identifies the sampling context
command	Action specific to your user library (for example, the JADE-supplied library uses this command for filtering)
userNumber	Identifies the sample in the corresponding user library invocations
userText	In conjunction with the userNumber parameter, identifies the sample

The JADE-supplied library automatically writes the user command record (type 13).

For more details, see "JADE Sampling Libraries" and "Statistics File Format", later in this chapter.