FiletransferUpdate

From TrillWiki

The filetransferUpdate function will update non status information for an existing file transfer. Such as file size, file name, start size, local or remote screen name.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "filetransferUpdate", struct filetransfer_update_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

FiletransferUpdate utilitizes the filetransfer_update_t structure.

struct filetransfer_update_t {  
 	unsigned int			struct_size; 
 
 	char				*medium; 
 
 	int				connection_id; 
 	int				filetransfer_id; 
 
 	unsigned int			file_size; 
 	unsigned int			start_size; 
 
 	char				*local_screen_name; 
 	char				*remote_screen_name; 
 	char				*filename; 
 };

medium

The medium for the file transfer.

connection_id

The connection id associated with the file transfer.

filetransfer_id

The file transfer id returned on filetransferInit.

file_size

The updated file size. If you want this to stay the same, set this to 0xFFFFFFFF (i.e. -1 wrapped i.e. -1 cast to an unsigned int).

start_size

The updated start size. If you want this to stay the same, set this to 0xFFFFFFFF (i.e. -1 wrapped i.e. -1 cast to an unsigned int).

local_screen_name

The local screen name. Set this to NULL if you want it to stay the same.

remote_screen_name

The remote screen name. Set this to NULL if you want it to stay the same.

Return Value

Negative value on error, 0 on success.

Remarks

To update the status or bytes received, please use the filetransferStatus method.