XferGetCurrFileName Method

Navigation:  Reference Guide > File Transfer >

XferGetCurrFileName Method

Previous pageReturn to chapter overviewNext page

Retrieves the name of file being transferred for a communication channel (direct serial connection or modem connection).

XferGetCurrFileName(short ChannelID, BSTR *FileName, long *Size, VARIANT_BOOL *Result);

Parameters

ChannelID

    A channel ID (0-7) used to identify a communication channel.

FileName

    A pointer to a buffer that receives a null-terminated character string containing the file name.

Size

    A pointer to the variable that receives the size, in characters, of the file name string.

Result

    If the method succeeds, the value of variable pointed to by Result is VARIANT_TRUE, otherwise the value is VARIANT_FALSE.