>> Ressourcen > Archiv > Maurer H. (Ed.)[..] > F Hyper-G Clien[..] > F.3 Description[..]

ErstesErstesVorherigesNächstesLetztes 3/6

F.3 Description of messages

This section contains a short description of each kind of message that may be sent, in the order of their message identifiers. The order of message identifiers assigned to messages is based on historic evolution of the protocol and is of no further relevance. Some message identifiers are not assigned. These typically have been used by some previous version of the protocol and are either obsolete commands or have been replaced by a new command with another message identifier.

For each message, we provide the message identifier together with a symbolic name, the parameters sent and return values received (from the client viewpoint), a short description of what the procedure does, and possible error codes returned. Section F.4 contains an overview of all error codes.

The notation int indicates that an integer is sent, string indicates that a string is sent and int foo[] indicates that an array of integers is sent, with the number of integers sent equal to the integer sent immediately before, except when noted otherwise. The notation optional indicates that the argument may not be sent (for example, if it is null). The notation remainder indicates that the argument fills up the rest of the message. The other notation should be obvious.


F.3.10 Command 12: GETTEXT F.3.10 Command 12: GETTEXT
F.3.11 Command 14: INSDOC F.3.11 Command 14: INSDOC
F.3.12 Command 17: INSCOLL F.3.12 Command 17: INSCOLL
F.3.13 Command 19: GETSRCSBYDEST F.3.13 Command 19: GETSRCSBYDEST
F.3.14 Command 22: MVCPDOCSCOLL F.3.14 Command 22: MVCPDOCSCOLL
F.3.15 Command 23: MVCPCOLLSCOLL F.3.15 Command 23: MVCPCOLLSCOLL
F.3.16 Command 24: IDENTIFY F.3.16 Command 24: IDENTIFY
F.3.17 Command 25: READY F.3.17 Command 25: READY
F.3.18 Command 26: COMMAND F.3.18 Command 26: COMMAND
F.3.19 Command 27: CHANGEOBJECT F.3.19 Command 27: CHANGEOBJECT
F.3.1 Command 2: GETDOCBYANCHOR F.3.1 Command 2: GETDOCBYANCHOR
F.3.20 Command 28: EDITTEXT F.3.20 Command 28: EDITTEXT
F.3.21 Command 29: GETANDLOCK F.3.21 Command 29: GETANDLOCK
F.3.22 Command 30: UNLOCK F.3.22 Command 30: UNLOCK
F.3.23 Command 31: INCOLLECTIONS F.3.23 Command 31: INCOLLECTIONS
F.3.24 Command 32: INSERTOBJECT F.3.24 Command 32: INSERTOBJECT
F.3.25 Command 33: INCOLLSCLUSTER F.3.25 Command 33: INCOLLSCLUSTER
F.3.26 Command 34: GETOBJBYFTQUERY F.3.26 Command 34: GETOBJBYFTQUERY
F.3.27 Command 35: GETOBJBYFTQUERYCOLL F.3.27 Command 35: GETOBJBYFTQUERYCOLL
F.3.28 Command 36: PIPEDOCUMENT F.3.28 Command 36: PIPEDOCUMENT
F.3.29 Command 37: DELETEOBJECT F.3.29 Command 37: DELETEOBJECT
F.3.2 Command 3: GETCHILDCOLL F.3.2 Command 3: GETCHILDCOLL
F.3.30 Command 38: PUTDOCUMENT F.3.30 Command 38: PUTDOCUMENT
F.3.31 Command 39: GETREMOTE F.3.31 Command 39: GETREMOTE
F.3.32 Command 40: GETREMOTECHILDREN F.3.32 Command 40: GETREMOTECHILDREN
F.3.33 Command 41: PIPEREMOTE F.3.33 Command 41: PIPEREMOTE
F.3.34 Command 42: HG_BREAK F.3.34 Command 42: HG_BREAK
F.3.35 Command 43: HG_MAPID F.3.35 Command 43: HG_MAPID
F.3.36 Command 44: GETCHILDREN F.3.36 Command 44: GETCHILDREN
F.3.3 Command 4: GETPARENT F.3.3 Command 4: GETPARENT
F.3.4 Command 5: GETCHILDDOCCOLL F.3.4 Command 5: GETCHILDDOCCOLL
F.3.5 Command 7: GETOBJECT F.3.5 Command 7: GETOBJECT
F.3.6 Command 8: GETANCHORS F.3.6 Command 8: GETANCHORS
F.3.7 Command 9: GETOBJBYQUERY F.3.7 Command 9: GETOBJBYQUERY
F.3.8 Command 10: GETOBJBYQUERYCOLL F.3.8 Command 10: GETOBJBYQUERYCOLL
F.3.9 Command 11: OBJECTBYIDQUERY F.3.9 Command 11: OBJECTBYIDQUERY