RetrieveUserGroups Method

Retrieves user groups.

Syntax

sapquery.retrieveUserGroups([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 retrieves any user groups that fit the search parameters specified in UserGroup and populates QueryUserGroups with a comma separated list of each user group found.

For example, you can do something like this:

SapQuery1.WorkSpace = SapqueryWorkSpaces.wsGlobalArea;
SapQuery1.UserGroup = "/SAP*";
SapQuery1.RetrieveUserGroups();

"/SAPQUERY/BP,/SAPQUERY/QD,/SAPQUERY/SQ".