Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Agent Administration Methods › SetTraceCallback Method—Registers Subroutine that Processes Trace Messages

SetTraceCallback Method—Registers Subroutine that Processes Trace Messages

The SetTraceCallback method registers a user-defined Perl subroutine that processes SiteMinder trace messages. If multiple subroutines are registered, SiteMinder calls the most recently registered subroutine.

Syntax

The SetTraceCallback method has the following format:

Netegrity::AgentAPI‑>SetTraceCallback(subref[, mode][, delim]
[, configFileName])

Parameters

The SetTraceCallback method accepts the following parameters:

subref (string)

Specifies the name of the Perl subroutine or a reference to the subroutine:

• name

  Example:

  $agentapi‑>SetErrorCallback("CustomTraceHandler");
  

• reference

  Example:

  $agentapi‑>SetErrorCallback(\&CustomTraceHandler);
  

  mode (string)

(Optional) Specifies an output format for the trace messages:

• default

  Specifies fields enclosed by square brackets.

• fixed

  Specifies fixed-width fields.

• delim

  Specifies using a character to delimit the fields.

• xml

  Specifies fields enclosed by XML-like tags.

  delim (string)

(Optional) Specifies the character to use as a delimiter when mode is set to delim.

configFileName (string)

(Optional) Specifies the name of the configuration file that specifies the data to be included in the trace.

Default: If no filename is specified, default settings are used.

Return Value

The SetTraceCallback method returns one of the following integer values:

• value = 1

  Specifies that registration was successful.

• value = 0

  Specifies that registration failed.