Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
HP ToolTalk Programmer's Guide > Chapter 20 ToolTalk Message Sets

Desktop Definitions and Conventions

» 

Technical documentation

» Feedback
Content starts here

 » Table of Contents

 » Glossary

This section defines terms and error messages unique to the Desktop Services message set. Specific to the desktop services messages are values associated with fields as described in Table 20-3.

Table 20-3 Values Associated with Fields

FieldAssociated Value
booleanA vtype for logical values. The underlying data type of boolean is integer; manipulate arguments of this vtype with tt_*_arg_ival[_set]() and tt_*_iarg_add(). A zero value means false; a non-zero value means true.
bufferA volatile, non-shared (for example, in-memory) representation of persistent data.
bufferIDA vtype that uniquely identifies buffers. The underlying data type of bufferID is string. To guarantee bufferID uniqueness, use the form <internal_counter> <procID>
messageIDA vtype that uniquely identifies messages. The underlying data type of messageID is string; manipulate arguments of this vtype with tt_*_arg_val[_set]() and tt_*_arg_add(). To guarantee messageID uniqueness, use the form <internal_counter> <procID>tt_message_id() returns an opaque string of similar uniqueness. Use tt_message_id() to generate a message's messageID; however, the inter-client conventions explicitly include the messageID as a message argument to support inter-operation with other versions of the ToolTalk service.
typeAny vtype that is the name of the kind of objects in a particular persistent-object system. For example, the vtype for the kind of objects in filesystems is File; the vtype for ToolTalk objects is ToolTalk_Object
vendortoolNametoolVersionNames of arguments. These strings appear in several of the Desktop Service messages. These strings are not defined rigorously; they are intended to present to the user descriptions of these three attributes of the relevant procid.
viewA screen display, such as a (portion of a) window, that presents to the user part or all of a document.
viewIDA vtype that uniquely identifies views. The underlying data type of viewID is string. To guarantee viewID uniqueness, use the form <internal_counter> <procID>

 

Errors

Table 20-4 describes the Desktop Services error messages; the error messages are listed in order of their message ID.

Table 20-4 Desktop Services Error Messages

Message IDError MessageError Message StringDescription
1538TT_DESKTOP_ENOENTNo such file or directory 
1549TT_DESKTOP_EACCESPermission Denied 
1558TT_DESKTOP_EINVALInvalid argumentAn argument's value was not valid; for example, a locale in Set_Locale that is not valid on the handler's host. Use this error status only when a more-specific error status does not apply.
1571TT_DESKTOP_ENOMSGNo message of desired typeA messageID does not refer to any message currently known by the handler.
1610TT_DESKTOP_EPROTOProtocol errorA message was not understood because:a. A required argument was omitted.b. An argument has the wrong vtype, or the vtype is not allowed in this message; for example, the vtype boolean in the Get_Geometry message.c. An argument's value is not legal for its vtype; for example, negative values for width in the Set_Geometry message.d. An argument's value is not legal for this message; for example, the PATH=/foo variable in Get_Environment message. In general, this error status indicates that the message is malformed.
1688TT_DESKTOP_CANCELEDOperation was canceledThe operation was canceled because of direct or indirect user intervention. An example of indirect intervention is the user terminating the handling process, or receipt of a Quit() request. (All messages should be taken as authentically representing the wishes of the user whose uid is indicated by tt_message_uid().)
1689TT_DESKTOP_ENOTSUPOperation not supportedThe requested operation is not supported by this handler. This error indicates that a handler assumes that, if it rejects a request, no other handler will be able to perform the operation. For example, a request such as Set_Iconified() or a request that refers to a state (such as a bufferID) that is managed by this handler alone. A request failed with this error, distinguishes the case of an incompletely-implemented handler from the case of the absence of a handler.
NOTE: Do not use TT_ERR_UNIMP in place of TT_DESKTOP_ENOTSUP, as TT_ERR_UNIMP means that a particular feature of ToolTalk itself is not implemented.
1699TT_DESKTOP_UNMODIFIEDOperation does not apply to unmodified entities. 

 

WARNING! The vtype namespace for persistent objects currently only contains File and ToolTalk_Object. Vendors who want to define a type should give it a vendor-specific name.

Table 20-5 lists each of the generic messages that constitute the ToolTalk Desktop Services Message Set. For details, see the Section 4 man pages.

Table 20-5 ToolTalk Desktop Services Message Set

MessageDecsription
Get_Modified (Request)Asks whether an entity (for example, a file) has been modified.
Get_Status (Request)Requests that a tool's current status be returned.
Get_Sysinfo (Request)Retrieves information about a tool's host.
Modified, Reverted (Request)Notifies that an entity (for example, a file) has been either modified or reverted to its prior state.
Pause, Resume (Request)Requests the specified tool, operation, or data performance to pause or resume.
Quit (Request)Requests that an operation, or an entire tool, terminate.
Raise, Lower (Request)Raises or lowers a tool's window(s) to the front or back, respectively.
Save, Revert (Request)Saves or discards any modifications to an entity (for example, a file).
Saved (Notice)Notifies that an entity (such as a file) has been saved to persistent shortage.
Set_Environment,
Get_Environment (Request)
Requests that a tool's environment either be set or retrieved.
Set_Geometry,
Get_Geometry (Request)
Requests that a tool's on-screen geometry either be set or retrieved.
Set_Iconified,
Get_Iconified (Request)
Requests that a tool's iconic state be set or retrieved.
Set_Locale,
Get_Locale (Request)
Sets or retrieves a tool's locale.
Set_Mapped,
Get_Mapped (Request)
Requests that a tool's mapping to the screen be set or retrieved.
Set_Situation,
Get_Situation (Request)
Requests that tool's current working directory be set or reported.
Get_XInfo (Request)Requests that a tool's X11 attributes be set or retrieved.
Signal (Request)Requests that a (POSIX-style) signal be sent to a tool.
Started,
Stopped (Notice)
Notifies that a tool has started or terminated.
Status (Notice)Notifies that a tool has status information to announce.

 

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© Hewlett-Packard Development Company, L.P.