world.ChatStopFileTransfer

MUSHclient script function (Method) — introduced in version 3.37

Stops a file transfer in progress to that chat user

Prototype

long ChatStopFileTransfer(long ID);

Data type meanings

Description

If a file transfer is in progress (send or receive) it is aborted, and the user at the other end notified, if possible.

You can use GetChatInfo to see if a file transfer is in progress.

Each call is identified by its "chat ID" - each chat session has a unique ID, which starts at one, and is incremented by one, per world.

You can use GetChatList to find a list of chat IDs that is current.

You can use ChatGetID to find the chat ID corresponding to a particular chat name.

VBscript example

ChatStopFileTransfer ChatGetID ("peter")

Jscript example

ChatStopFileTransfer (ChatGetID ("peter"));

PerlScript example

ChatStopFileTransfer (ChatGetID ("peter"));

Python example

world.ChatStopFileTransfer (world.ChatGetID ("peter"))

Lua example

ChatStopFileTransfer (ChatGetID ("peter"))

Return value

eChatIDNotFound: That chat ID is not connected.
eNotTransferringFile: We are not transferring a file.
eOK: File transfer aborted.

Return code meanings

Related topic

Chat system

See also