Inside Macintosh: Apple Game Sprockets Guide /

Chapter 4 - NetSprocket / NetSprocket Reference

NetSprocket Functions / Managing Groups of Players

NSpGroup_GetInfo

You can use the NSpGroup_GetInfo function to obtain the group's information structure.

OSStatus NSpGroup_GetInfo (
	NSpGameReference inGame,
	NSpGroupID inGroupID,
	NSpGroupInfoPtr *outInfo);

inGame

An opaque reference to your game object.

inGroupID

The group you want information about.

outInfo

A pointer to an array of group information structures.

function result

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

DESCRIPTION

The group information data structure will be allocated by NetSprocket and the structure will be populated with the group's information. For efficient memory management, the NSpGroupInfo data structure should be released with a call to NSpGroup_ReleaseInfo when you have finished using it.

NetSprocket returns an error if NetSprocket could not build the group information data structure or if the group ID was invalid.