Inventu Viewer+ Server Macros

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Navigation: Implementing the ServerMacro Class > ServerMacro Members > Client Interaction Methods

PutClientFile - will send/download a file to the client and display a message to the user

PutClientFile will send/download a file to the client and display a message to the user along with action buttons

MacroDialogRC PutClientFile(string filePath, string message, string title
[, MacroMessageType icon] [, MacroButtons buttons] [, int timeOut])

Parameters

filePath

Required. The full path to the file to be sent /downoaded to the client.

message

Required. The message that is displayed to the client describing the file being sent / downloaded.

title

Required. The title displayed at the top of the download message at the client.

icon

Optional. Icon to be displayed. Default value is MacroMessageType.info

buttons

Optional. Buttons to be displayed. Default value is MacroButtons.ok

timeout

Optional. Number of milliseconds to wait for client response. -1 means no timeout (indefinite wait). Default value is -1 (indefinite wait)

Remarks

What occurs at the client depends on the web browser being used. The file is sent as a standard HTTP encapsulated file, so the behavior should be familiar to the user. Note that since users can cancel a file download, the return code and button clicked is the only way for the user to indicate an "ignored" file.

Example

Please refer to the full example of file upload/download in the GetClientFile section.