NAME

Deposit - save a document to its backing store

SYNOPSIS

[file] Deposit(in mediaType contents

[in messageID commission]);

DESCRIPTION

The Deposit request saves a document to its backing store. This request is different from the Save request in that the requester (not the handler) has the data to be saved.

The contents argument is the contents of the document. If this argument is unset (in other words, has a value of (char * )0), then the contents of the document are in the file named in the message's file attribute. The data type (mediaType) of the contents argument should be string, unless nulls are valid in the given media type, in which case the data type must be bytes.

The commission argument contains the message ID of the Edit request that caused the creation of this buffer.

APPLICATION USAGE

The ttmedia_load(3) function can be used to register for, and help process, this message.

This message can be sent with the ttmedia_Deposit(3) function.

The Deposit request is useful for cases where the user may perform an intermediate save of modifications to a document that is the subject of an Edit or Display request in progress. In the latter case, the Deposit may fail on a TT_DESKTOP_EACCES error if the handler does not allow updates to the document being displayed.

Handlers receiving this request should reply before deleting any file named in the message's file attribute, but this is optional and applications should not rely on this.

ERRORS

The ToolTalk service may return one of the following errors in processing the Deposit request:

TT_DESKTOP_EACCES

The document is read-only.

TT_DESKTOP_ENOENT

The file that was alleged to contain the document does not exist.

TT_DESKTOP_ENODATA

The in-mode contents argument had no value and the file attribute of the message was not set.

TT_MEDIA_ERR_FORMAT

The document is not a valid instance of the media type.

SEE ALSO

ttmedia_load(3), ttmedia_Deposit(3); Intro, Display, Edit, Status requests.