AvatarRemoteSet

From TrillWiki

The avatarRemoteSet function will set a buddy icon for a particular remote user on a medium.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "avatarRemoteSet", struct avatar_t *);

Note that all Trillian functions and notifications begin with a lower-case letter, despite the Wiki requirement that all pages start with a capital letter.

Parameters

AvatarRemoteSet utilitizes the avatar_t structure.

struct avatar_t
{
	unsigned int				struct_size;

	int					connection_id;
	int					window_id;
	int					timestamp;
	int					data_length;

	char					*medium;
	char					*name;
	char					*filename;
	char					*data;

	/* 3.0
	 */
	int					force_file_size;
	int					force_image_dimensions;
	int					allowed_image_types;

	int					image_width;
	int					image_height;
	
	int					file_size;

	/* 3.1
	 */
	char					*section;
};

connection_id

The connection to set the icon for.

medium

The medium to set the icon for.

data_length

The length of the data if used (if filename is NULL).

name

The name of the user to set the icon for.

filename

A buffer that will be filled with the filename. The filename buffer must have allocated to support at least MAX_PATH characters.

data

If the filename is NULL, the data is used. This will be binary data for the avatar. Use the data_length field to specify how much data is in this field.

Return Value

Returns a negative value on error, 0 on success.

Remarks

None.