Phantasmal Site > Phantasmal API > API Listing > subscribe_user

API Function: subscribe_user

Summary:

subscribe a user to a channel

Defined In LPC Object:

/usr/common/sys/channeld.c

Prototype:

int subscribe_user(object user, int channel, varargs int arg)

Can Be Called By:

System, Common, Game

Description:

Subscribe the user to the given channel. When content is sent on the channel, the user will receive it.

Return Value:

Returns -1 if the user cannot be subscribed for some reason. Returns 1 if the subscription is successful.

Errors:

Normally none

See Also:

channel_list , get_channel_by_name , string_to_channel , unsubscribe_user