Description of MUSHclient world function: world.ChatSendFile
||Starts sending a file to the specified chat user
long ChatSendFile(long ID, BSTR FileName);
View list of data type meanings
This starts the process of sending a file to the specified chat ID.
If the file name is empty, then you will be prompted with a "choose file" dialog box, so you can pick the file with the normal Window file browser.
If the file name is not empty, then MUSHclient will attempt to send that file.
The recipient of the file must have allowed file sending, or you will get an error message.
You cannot send more than one file at a time - you will get an error if you attempt to send a file whilst sending, or receiving, another one (to that user).
You can use GetChatInfo to see if a file transfer is in progres.
You can use SetChatOption to set the "can_send_files" flag.
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 that an "OK" response merely means that we have sent a request to the other user to accept the file. There is no guarantee that s/he will want it.
Note: Available in version 3.37 onwards.
ChatSendFile ChatGetID ("fred"), "" ' send a file that you choose
ChatSendFile (ChatGetID ("fred"), ""); // send a file that you choose
ChatSendFile (ChatGetID ("fred"), ""); # send a file that you choose
world.ChatSendFile (world.ChatGetID ("fred"), "") # send a file that you choose
ChatSendFile (ChatGetID ("fred")) -- send a file that you choose
The file name is optional. If omitted you will be prompted for one.
eChatIDNotFound: That chat ID is not connected
eAlreadyTransferringFile: Already transferring a file
eFileNotFound: That file not found, or user cancelled file picker dialog box
eOK: File transfer initiated
View list of return code meanings
|Introduced in version
See also ...
||Looks up what chat ID (identifier) corresponds to a particular chat name
||Stops a file transfer in progress to that chat user
||Get information about a chat connection
||Gets the value of a chat session option
||Sets the value of a chat session option
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.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise
of the function.
view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
view a list of the data types used in function prototypes
View all functions
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.
Gammon Software support
Forum RSS feed ( https://gammon.com.au/rss/forum.xml )