Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.ChatStopFileTransfer

Name ChatStopFileTransfer
Type Method
Summary Stops a file transfer in progress to that chat user
Prototype long ChatStopFileTransfer(long ID);

View list of 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.

Note: Available in version 3.37 onwards.
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"))
Returns eChatIDNotFound: That chat ID is not connected.
eNotTransferringFile: We are not transferring a file.
eOK: File transfer aborted.

View list of return code meanings
Introduced in version 3.37

See also ...

Function Description
ChatGetID Looks up what chat ID (identifier) corresponds to a particular chat name
ChatSendFile Starts sending a file to the specified chat user
GetChatInfo Get information about a chat connection

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home