getControlAttributeFromRequest()

This function can be used in a hook to get the value of any controlling attribute as available in the request. It must only be used in batch implementations.

function boolean getControlAttributeFromRequest(long i.request, const string i.name, ref string o.value)

Input:

• i.request: request provided as input in a before, on or after execute hook.
• i.name: name of the control attribute (case-sensitive).

Output:

• return value: true if the control attribute exists in the request and its value can be retrieved, false otherwise.
• o.value: the value of the control attribute, “” if return value is false.