File: chat_kick

package info (click to toggle)
pork 0.99.8.1-2.1
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 3,936 kB
  • sloc: ansic: 35,011; sh: 3,379; perl: 931; makefile: 549
file content (14 lines) | stat: -rw-r--r-- 519 bytes parent folder | download | duplicates (6) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
SYNTAX: PORK::chat_kick(chat_room, user, reason, [account])
	Kicks a user from a chat room.

INPUT PARAMETERS
	chat_room: The name/exchange combination of the chat room from which to kick the specified user user.
	user     : The user to kick.
	reason   : Reason for the kick.
	account  : (Optional) The account on whose behalf the action will be performed. If this parameter is omitted, the account active in the current window will be assumed.

RETURN VALUE
	Returns 0 on success, -1 on failure.

SEE ALSO
	chat kick