VCSAG_LOG_MSG
Prev	Logging agent messages	Next

---

VCSAG_LOG_MSG

The VCSAG_LOG_MSG function can be used to pass normal agent messages to the halog utility. At a minimum, the function must include the severity, the message within quotes, and a message ID. Optionally, the function can also include parameters and specify an encoding format.

Severity Levels (sev)	"C" - critical, "E" - error, "W" - warning, "N" - notice, "I" - information; place error code in quotes
Message (msg)	A text message within quotes; for example: "One file copied"
Message ID (msgid)	An integer between 0 and 65535
Encoding Format	UTF-8, ASCII, or UCS-2 in the form: "-encoding format"
Parameters	Parameters (up to six), each within quotes

VCSAG_LOG_MSG examples, Shell script entry points

• Calling a function without parameters or encoding format:

  VCSAG_LOG_MSG "<sev>" "<msg>" <msgid>

  VCSAG_LOG_MSG "C" "Two files found" 140

• Calling a function with one parameter, but without encoding format:

  VCSAG_LOG_MSG "<sev>" "<msg>" <msgid> "<param1>"

  VCSAG_LOG_MSG "C" "$count files found" 140 "$count"

• Calling a function with a parameter and encoding format:

		VCSAG_LOG_MSG "<sev>" "<msg>" <msgid> "-encoding <format>" 
"<param1>" 
 
		VCSAG_LOG_MSG "C" "$count files found" 140 "-encoding utf8" 
"$count"
 
  Note that if encoding format and parameters are passed to the functions, the encoding format must be passed before any parameters.

VCSAG_LOG_MSG examples, Perl script entry points

• Calling a function without parameters or encoding format:

  VCSAG_LOG_MSG ("<sev>", "<msg>", <msgid>);

  VCSAG_LOG_MSG ("C", "Two files found", 140);

• Calling a function with one parameter, but without encoding format:

  VCSAG_LOG_MSG ("<sev>", "<msg>", <msgid>, "<param1>";

  VCSAG_LOG_MSG ("C", "$count files found", 140, "$count");

• Calling a a function with one parameter and encoding format:

		VCSAG_LOG_MSG ("<sev>", "<msg>", <msgid>, "-encoding 
<format>", "<param1>");
 
		VCSAG_LOG_MSG ("C", "$count files found", 140, "-encoding 
utf8", "$count");
 

Note that if encoding format and parameters are passed to the functions, the encoding format must be passed before any parameters.