libguac 1.5.5
Loading...
Searching...
No Matches
Typedefs
argv-fntypes.h File Reference

Function type definitions related to automatic handling of received "argv" instructions. More...

Go to the source code of this file.

Typedefs

typedef int guac_argv_callback(guac_user *user, const char *mimetype, const char *name, const char *value, void *data)
 Callback which is invoked by the automatic "argv" handling when the full value of a received argument has been received.
 

Detailed Description

Function type definitions related to automatic handling of received "argv" instructions.

Typedef Documentation

◆ guac_argv_callback

typedef int guac_argv_callback(guac_user *user, const char *mimetype, const char *name, const char *value, void *data)

Callback which is invoked by the automatic "argv" handling when the full value of a received argument has been received.

Parameters
userThe user that opened the argument value stream.
mimetypeThe mimetype of the data that will be sent along the stream.
nameThe name of the connection parameter being updated. It is up to the implementation of this handler to decide whether and how to update a connection parameter.
valueThe value of the received argument.
dataAny arbitrary data that was provided when the received argument was registered with guac_argv_register().
Returns
Zero if the received argument value has been accepted and has either taken effect or is being intentionally ignored, non-zero otherwise.