#include <fte.h>
DWORD WINAPI xfGetStatusText(hConnection, nInfo, lpText, cbMax)
HCONNECTION hConnection; /* handle of connection about which to get information */
int nInfo; /* specifies type of information to get */
LPSTR lpText; /* pointer to buffer that receives text (string) */
int cbMax; /* maximum size of string to fit in buffer */
The xfGetStatusText function gets text (string) information about the file transfer session.
Parameters
hConnection
Specifies the connection about which to get information.
nInfo
Specifies the type of information to get. It can be one of these values:
Value | Meaning |
XF_GST_DESTFILENAME | Name of file being written. |
XF_GST_FRIENDLYNAME | Optional name describing the group of files. |
XF_GST_LOCALNAME | Name of the local user. |
XF_GST_OPENNAME | Optional name of file to open after transfer is complete. |
XF_GST_SOURCEFILENAME | Name of file being sent. |
XF_GST_REMOTENAME | Name of the remote user. |
lpText
Pointer to the buffer that receives the information.
cbMax
Maximum size (in bytes) of the buffer (including a null terminating character).
Return Value
The return value is the number of bytes, not including the terminating null character, in the returned character string. If there is a problem with the retrieval, the return value is 0:
See Also
xfGetStatusLong, xfGetVersion.