getresponderactionResult Structure Definition

The getresponderactionResult structure defines the return type for getresponderaction API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

responderactionList

List of responderactions


responderaction Structure Definition

The responderaction structure defines the actual return type values for getresponderaction API.

Syntax



Members

name

Name of the responder action.

type

Type of responder action. It can be: (respondwith).

target

Expression specifying what to to respond with

htmlpage

Option specifying to respondwith htmlpage

bypasssafetycheck

The safety check to allow unsafe expressions.
NOTE: This attribute is deprecated.
This parameter is deprecated and its value is ignored.

hits

The number of times the action has been taken.

referencecount

The number of references to the action.

undefhits

The number of times the action resulted in UNDEF.

comment

Comment. Any type of information about this responder action.

builtin

Flag to determine whether responder action is built-in or not

responsestatuscode

HTTP response status code, for example 200, 302, 404, etc. The default value for the redirect action type is 302 and for respondwithhtmlpage is 200

reasonphrase

Expression specifying the reason phrase of the HTTP response. The reason phrase may be a string literal with quotes or a PI expression. For example: "Invalid URL: " + HTTP.REQ.URL

_nextgenapiresource


See Also