Phantasmal Site > Phantasmal API > API Listing > is_subscribed

API Function: is_subscribed

Summary:

return whether a user is subscribed to a channel

Defined In LPC Object:

/usr/common/sys/channeld.c

Prototype:

int is_subscribed(object user, int channel)

Can Be Called By:

System, Common, Game

Description:

Returns a number to indicate whether the given user is subscribed to the given channel.

Return Value:

Returns 1 if the user is subscribed, 0 if s/he isn't, and -1 if the request cannot be completed.

Errors:

Normally none.

See Also:

get_channel_by_name , string_to_channel , subscribe_user