ChatSendFile
Script function

world.ChatSendFile

DOC_scripting Read about scripting

Type

Method

Summary

Starts sending a file to the specified chat user

Prototype

long ChatSendFile(long ID, BSTR FileName);

DOC_data_types View list of data type meanings

Description

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.

VBscript example

ChatSendFile ChatGetID ("fred"), ""  ' send a file that you choose


Jscript example

ChatSendFile (ChatGetID ("fred"), ""); // send a file that you choose


PerlScript example

ChatSendFile (ChatGetID ("fred"), "");  # send a file that you choose


Python example

world.ChatSendFile (world.ChatGetID ("fred"), "") # send a file that you choose


Lua example

ChatSendFile (ChatGetID ("fred")) -- send a file that you choose


Lua notes

The file name is optional. If omitted you will be prompted for one.


Return value

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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_chat Chat system
DOC_starting Getting started

Functions

FNC_ChatAcceptCalls ChatAcceptCalls (Accepts incoming chat calls)
FNC_ChatCall ChatCall (Calls a chat server (makes an outgoing call) using the MudMaster chat protocol)
FNC_ChatCallzChat ChatCallzChat (Calls a zChat chat server (makes an outgoing call))
FNC_ChatDisconnect ChatDisconnect (Disconnects a current chat call)
FNC_ChatDisconnectAll ChatDisconnectAll (Disconnects all current chat calls)
FNC_ChatEverybody ChatEverybody (Sends a chat message to every connected chat user)
FNC_ChatGetID ChatGetID (Looks up what chat ID (identifier) corresponds to a particular chat name)
FNC_ChatGroup ChatGroup (Sends a chat message to every connected chat user in the specified group)
FNC_ChatID ChatID (Sends a chat message to a particular chat session)
FNC_ChatMessage ChatMessage (Sends a message to a chat user (raw format))
FNC_ChatNameChange ChatNameChange (Changes your chat name)
FNC_ChatNote ChatNote (Does a note using ANSI codes for the chat system)
FNC_ChatPasteEverybody ChatPasteEverybody (Pastes the clipboard contents to every connected person)
FNC_ChatPasteText ChatPasteText (Pastes the clipboard contents to that person)
FNC_ChatPeekConnections ChatPeekConnections (Sends a "peek connections" message to the specified chat user)
FNC_ChatPersonal ChatPersonal (Sends a chat message to a particular person)
FNC_ChatPing ChatPing (Sends a ping message to the specified chat user)
FNC_ChatRequestConnections ChatRequestConnections (Sends a "request connections" message to the specified chat user)
FNC_ChatStopAcceptingCalls ChatStopAcceptingCalls (Stops this world from accepting chat calls)
FNC_ChatStopFileTransfer ChatStopFileTransfer (Stops a file transfer in progress to that chat user)
FNC_GetChatInfo GetChatInfo (Get information about a chat connection)
FNC_GetChatList GetChatList (Gets the list of chat sessions)
FNC_GetChatOption GetChatOption (Gets the value of a chat session option)
FNC_SetChatOption SetChatOption (Sets the value of a chat session option)

(Help topic: function=ChatSendFile)

DOC_contents Documentation contents page