SetRequestParam Method

Shortcut to easily set a request parameter's value.

Syntax

sapclient.setRequestParam(name, value, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method can be used to easily update the value of a parameter contained in the RequestParameters collection. Instead of walking through the collection element by element, simply call SetRequestParam with the name of the parameter you want to change, along with the value you want to set it to. This method will find the parameter in the RequestParameters collection with the specified Name, and then updates it with the supplied Value.

If no request parameter with the indicated Name exists, the class fails with an error.