Inside Macintosh: Apple Game Sprockets Guide /

Chapter 4 - NetSprocket / NetSprocket Reference

NetSprocket Functions / Managing Groups of Players

NSpGroup_RemovePlayer

You can use the NSpGroup_RemovePlayer function to remove a player from a group.

OSStatus NSpGroup_RemovePlayer (
	NSpGameReference inGame,
	NSpGroupID inGroupID,
	NSpPlayerID inPlayerID);

inGame

An opaque reference to your game object.

inGroupID

The group from which the player is to be removed.

inPlayerID

The player to be removed.

function result

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

DESCRIPTION

NetSprocket returns an error if the NSpGroup_RemovePlayer function could not remove the player or if the player ID or group ID is invalid. This function does not delete the player from the game. It only removes the player from the list of players in the group.