Function

Purplecmd_help

Declaration [src]

GList*
purple_cmd_help (
  PurpleConversation* conv,
  const gchar* cmd
)

Description [src]

Get the help string for a command.

Parameters

conv PurpleConversation
 

The conversation, or NULL for no context.

 The data is owned by the caller of the function.
cmd const gchar*
 

The command. No wildcards accepted, but returns help for all commands if NULL.

 The data is owned by the caller of the function.
 The value is a NUL terminated UTF-8 string.

Return value

Returns: A list of utf8
 

The help strings for a given command, one node for each matching command.

 The caller of the function takes ownership of the data container, but not the data inside it.
 Each element is a NUL terminated UTF-8 string.