AvatarRemoteGet

From TrillWiki

The avatarRemoteGet function retrieves an avatar from a specific user on a medium (if it has been retrieved and cached already by Trillian).

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "avatarRemoteGet", 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

AvatarRemoteGet 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 get the icon for.

medium

The medium to get the icon for.

name

The name of the user to retrieve 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.

Return Value

Returns a negative value on error, 0 on success.

Remarks

This function will not query for the avatar from the actual medium dll, it will only return back what Trillian has cached.