logUserCommand

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

The logUserCommand method of the Node class invokes the NodeSampleUserCommandCallBack entry point in the user library, 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 and setting the SamplingExceptionEvent)
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 (type 13).

For more details, see "JADE Sampling Libraries" and "Statistics File Format", later in this chapter. See also "Sampling Exception Handling", later in this chapter, for details about handling node sampling exceptions.