Multiuser Lingo Dictionary > Multiuser Lingo Dictionary > getUsers |  |

getUsers

Syntax

    system.group.getUsers ["@groupName"]

Description

Multiuser Server command; gets the list of members for a particular group or groups.

If there is more than one group, the server responds with a separate message for each of the groups requested. Each response has the same subject as the original request. The reply message's contents are in the form of a property list with two properties, the first for the group name and the second for the members.

For large groups, the return message may be fairly long. Be certain that the server and Xtra message buffers are large enough to contain the list of all group members. See `setNetBufferLimits` and Server application overview.

Example

This statement has the server return a list of members in the @RedTeam group:

    errCode = gMultiuserInstance.sendNetMessage("system.group.getUsers", "anySubject", "@RedTeam")

The server's response looks like this:

    [#errorCode: 0, #recipients: ["userName"], #senderID: "system.group.getUsers", #subject: "anySubject", #content: [#groupName: "@RedTeam", #groupMembers: ["Mark", "Jane", "Chris"]], #timeStamp: 98324982]

See also

`sendNetMessage()`