$Web LogMsg: Difference between revisions
m (1 revision) |
m (1 revision) |
||
| Line 4: | Line 4: | ||
$Web_LogMsg retrieves a saved logon messages. | <var>$Web_LogMsg</var> retrieves a saved logon messages. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %MSG = $Web_LogMsg( num ) | <p class="syntax"><section begin="syntax" /> %MSG = $Web_LogMsg( num ) | ||
| Line 10: | Line 10: | ||
$Web_LogMsg takes one argument and returns a string, or null for any error condition. | <var>$Web_LogMsg</var> takes one argument and returns a string, or null for any error condition. | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>num</th> | <tr><th>num</th> | ||
| Line 19: | Line 19: | ||
If the port definition contains a LOGMSGI parameter (), <var>$Web_LogMsg</var> will always return a null. If an invalid message number is specified (less than or equal to 0 or greater than the number of saved messages) <var>$Web_LogMsg</var> will return a null. | If the port definition contains a LOGMSGI parameter (), <var>$Web_LogMsg</var> will always return a null. If an invalid message number is specified (less than or equal to 0 or greater than the number of saved messages) <var>$Web_LogMsg</var> will return a null. | ||
$Web_Num_LogMsg and <var>$Web_LogMsg</var> are probably most useful in a JANUS WEB ON LOGONERR routine, but they can be used in any JANUS WEB ON routine. | <var>$Web_Num_LogMsg</var> and <var>$Web_LogMsg</var> are probably most useful in a JANUS WEB ON LOGONERR routine, but they can be used in any JANUS WEB ON routine. | ||
<p class="code"> FOR %I FROM 1 TO $Web_Num_LogMsg | <p class="code"> FOR %I FROM 1 TO $Web_Num_LogMsg | ||
%MSG = $Web_LogMsg(%I) | %MSG = $Web_LogMsg(%I) | ||
Revision as of 22:43, 18 October 2012
<section begin="desc" />Get saved logon message<section end="desc" />
$Web_LogMsg retrieves a saved logon messages.
Syntax
<section begin="syntax" /> %MSG = $Web_LogMsg( num ) <section end="syntax" />
$Web_LogMsg takes one argument and returns a string, or null for any error condition.
| num | The saved message number. This is a required argument. |
|---|
If the port definition contains a LOGMSGI parameter (), $Web_LogMsg will always return a null. If an invalid message number is specified (less than or equal to 0 or greater than the number of saved messages) $Web_LogMsg will return a null.
$Web_Num_LogMsg and $Web_LogMsg are probably most useful in a JANUS WEB ON LOGONERR routine, but they can be used in any JANUS WEB ON routine.
FOR %I FROM 1 TO $Web_Num_LogMsg %MSG = $Web_LogMsg(%I) IF $SUBSTR(%MSG, 1, 10) EQ 'M204.1500:' THEN JUMP TO GOTACF2MSG END IF END FOR
This is an example of how $Web_LogMsg can be used to scan logon messages looking for an ACF2 message that perhaps indicates the reason for a logon failure. Depending on the reason (incorrect password, expired password, suspended account) appropriate action can be taken. This type of loop is highly recommended rather than depending on a particular message number containing the required message. By requesting a hard-coded message number an application might expose itself to Model 204 or external authorizer release dependencies. In the same way, analysis or parsing of the message should be made as flexible as reasonable to avoid release dependencies.
See also $Web_Num_LogMsg.