Inside Macintosh: Apple Game Sprockets Guide /

Chapter 4 - NetSprocket / NetSprocket Reference

NetSprocket Functions / Managing Groups of Players

NSpGroup_GetEnumeration

You can use the NSpGroup_GetEnumeration function to obtain a list of the groups in the game.

OSStatus NSpGroup_GetEnumeration (
	NSpGameReference inGame,
	NSpGroupEnumerationPtr *outGroups);

inGame

An opaque reference to your game object.

outGroups

A pointer to the group enumeration structure that is allocated and populated by NetSprocket.

function result

A result code of noErr, or a NetSprocket or Open Transport result code.

DESCRIPTION

For efficient memory management, the group enumeration structure should be released by NetSprocket by calling NSpGroup_ReleaseEnumeration.

NetSprocket returns an error if it could not build the group list.