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

SetErrorCallback Method—Registers Subroutine that Processes Error Messages

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

Syntax

The SetErrorCallback method has the following format:

Netegrity::AgentAPI‑>SetErrorCallback(subref)

Parameters

The SetErrorCallback method accepts the following parameter:

subref (string)

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

• name

  Example:

  $agentapi‑>SetErrorCallback("CustomErrorHandler");
  

• reference

  Example:

  $agentapi‑>SetErrorCallback(\&CustomErrorHandler);
  

Return Value

The SetErrorCallback method returns one of the following integer values:

• value = 1

  Specifies that registration was successful.

• value = 0

  Specifies that registration failed.