Editing
Protocol
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
=Transaction Fields= There are 3 predefined field data types: integer, string and binary. If field data does not fit in the first two categories, it is sent as binary data and interpreted by the receiving machine. Some of the binary fields are currently used as strings. All integer fields are treated as unsigned, and can be sent as 16 or 32-bit numbers. This is determined by evaluation of the number itself. Namely, if integer can be represented using only 2 bytes, it is sent as such. In the case when the number is greater than 2^16, it’s sent as 32-bit number. String fields currently use 8-bit ASCII character set. '''Error Text (100)''' Constant: myField_ErrorText '''Data (101)''' Constant: myField_Data Type: Binary '''User Name (102)''' Constant: myField_UserName Type: String '''User ID (103)''' Constant: myField_UserID Type: Integer '''User Icon ID (104)''' Constant: myField_UserIconID Type: Integer '''User Login (105)''' Constant: myField_UserLogin Type: String '''User Password (106)''' Constant: myField_UserPassword Type: String '''Reference Number (107)''' Constant: myField_RefNum Type: Integer '''Transfer Size (108)''' Constant: myField_TransferSize Type: Integer '''Chat Options (109)''' Constant: myField_ChatOptions Type: Integer '''User Access (110)''' Constant: myField_UserAccess Type: Binary This field is represented as 64-bit bitmap. The specific bit meaning is described in the ''Access Privileges'' section of this document. '''User Alias (111)''' Constant: myField_UserAlias '''User Flags (112)''' Constant: myField_UserFlags Type: Integer User flags field is a bitmap with the following values: {| border="1" cellpadding="0" cellspacing="0" | style="width: 37px;" | Bit | style="width: 54px;" | Value | style="width: 499px;" | Description |- | style="width: 37px;" | 0 | style="width: 54px;" | 1 | style="width: 499px;" | User is away |- | style="width: 37px;" | 1 | style="width: 54px;" | 2 | style="width: 499px;" | User is admin (or disconnected?) |- | style="width: 37px;" | 2 | style="width: 54px;" | 4 | style="width: 499px;" | User refuses private messages |- | style="width: 37px;" | 3 | style="width: 54px;" | 8 | style="width: 499px;" | User refuses private chat |} '''Options (113)''' Constant: myField_Options Type: Integer '''Chat ID (114)''' Constant: myField_ChatID Type: Integer '''Chat Subject (115)''' Constant: myField_ChatSubject Type: String '''Waiting Count (116)''' Constant: myField_WaitingCount Type: Integer '''Server Agreement (150)''' Constant: myField_ServerAgreement '''Server Banner (151)''' Constant: myField_ServerBanner Type: Binary '''Server Banner Type (152)''' Constant: myField_ServerBannerType Type: Integer This field can have one of the following values: {| border="1" cellpadding="0" cellspacing="0" | style="width: 49px;" | Value | style="width: 114px;" | Equivalent Value | style="width: 427px;" | Description |- | style="width: 49px;" | 1 | style="width: 114px;" | ‘URL ‘ | style="width: 427px;" | URL link |- | style="width: 49px;" | 3 | style="width: 114px;" | ‘JPEG’ | style="width: 427px;" | JPEG file |- | style="width: 49px;" | 4 | style="width: 114px;" | ‘GIFf’ | style="width: 427px;" | GIF file |- | style="width: 49px;" | 5 | style="width: 114px;" | ‘BMP ‘ | style="width: 427px;" | BMP file |- | style="width: 49px;" | 6 | style="width: 114px;" | ‘PICT | style="width: 427px;" | PICT file |} '''Server Banner URL (153)''' Constant: myField_ServerBannerUrl Type: Binary '''No Server Agreement (154)''' Constant: myField_NoServerAgreement Type: Integer The value of this field is 1 if there is no agreement to be sent. '''Version (160)''' Constant: myField_Vers Type: Integer '''Community Banner ID (161)''' Constant: myField_CommunityBannerID Type: Integer '''Server Name (162)''' Constant: myField_ServerName Type: Binary '''File Name with Info (200)''' Constant: myField_FileNameWithInfo Type: Binary File name with info field content is presented in this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Type | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | Folder (‘fldr’) or other |- | style="width: 103px;" | Creator | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | File size | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | Reserved? |- | style="width: 103px;" | Name script | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Name size | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Name data | style="width: 42px;" | size | style="width: 66px;" | | style="width: 379px;" | |} '''File Name (201)''' Constant: myField_FileName Type: String '''File Path (202)''' Constant: myField_FilePath Type: Binary See [[Path Parameters]] for more info. '''File Resume Data (203)''' Constant: myField_FileResumeData Type: Binary File resume data field content is presented in this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Format | style="width: 42px;" | 4 | style="width: 66px;" | ‘RFLT’ | style="width: 379px;" | |- | style="width: 103px;" | Version | style="width: 42px;" | 2 | style="width: 66px;" | 1 | style="width: 379px;" | Currently 1 |- | style="width: 103px;" | RSVD | style="width: 42px;" | 34 | style="width: 66px;" | | style="width: 379px;" | ? |- | style="width: 103px;" | Fork count | style="width: 42px;" | 2 | style="width: 66px;" | 2 | style="width: 379px;" | Currently 2 |- | style="width: 103px;" | Fork info list… | style="width: 42px;" | | style="width: 66px;" | | style="width: 379px;" | |} Fork info list contains one or more records with the following structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Fork | style="width: 42px;" | 4 | style="width: 66px;" | ‘DATA’ | style="width: 379px;" | |- | style="width: 103px;" | Data size | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | Current file size |- | style="width: 103px;" | RSVD A | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | ? |- | style="width: 103px;" | RSVD B | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | ? |} '''File Transfer Options (204)''' Constant: myField_FileXferOptions Type: Integer '''File Type String (205)''' Constant: myField_FileTypeString Type: String '''File Creator String (206)''' Constant: myField_FileCreatorString Type: String '''File Size (207)''' Constant: myField_FileSize Type: Integer '''File Create Date (208)''' Constant: myField_FileCreateDate Type: Binary File create date field has this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Year | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Milliseconds | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Seconds | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |} See [[Date Parameters]] for more info. '''File Modify Date (209)''' Constant: myField_FileModifyDate Type: Binary File modify date field has this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Year | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Milliseconds | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Seconds | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |} See [[Date Parameters]] for more info. '''File Comment (210)''' Constant: myField_FileComment Type: String '''File New Name (211)''' Constant: myField_FileNewName Type: String '''File New Path (212)''' Constant: myField_FileNewPath Type: Binary '''File Type (213)''' Constant: myField_FileType Type: Binary File type field contains only one value: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | File type | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | File type code (‘fldr’ or other) |} '''Quoting Message (214)''' Constant: myField_QuotingMsg Type: Binary '''Automatic Response (215)''' Constant: myField_AutomaticResponse Type: String '''Folder Item Count (220)''' Constant: myField_FldrItemCount Type: Integer '''User Name with Info (300)''' Constant: myField_UserNameWithInfo Type: Binary User name with info field contains this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | User ID | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Icon ID | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | User flags | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | User name size | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | User name | style="width: 42px;" | size | style="width: 66px;" | | style="width: 379px;" | User name string |} '''News Category GUID (319)''' Constant: myField_NewsCatGUID '''News Category List Data (320)''' Constant: myField_NewsCatListData Type: Binary News category list data field contains this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 84px;" | Data | style="width: 361px;" | Note |- | style="width: 103px;" | Type | style="width: 42px;" | 1 | style="width: 84px;" | 1, 10 or 255 | style="width: 361px;" | Category folder (1), category (10) or other (255) |- | style="width: 103px;" | Category name | style="width: 42px;" | rest | style="width: 84px;" | | style="width: 361px;" | |} This field is used for client/server version 1.5 (prior to April 15, 1999?). '''News Article List Data (321)''' Constant: myField_NewsArtListData Type: Binary News article list data field contains this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | ID | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Article count | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | Number of articles |- | style="width: 103px;" | Name size | style="width: 42px;" | 1 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Name | style="width: 42px;" | size | style="width: 66px;" | | style="width: 379px;" | Name string |- | style="width: 103px;" | Description size | style="width: 42px;" | 1 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Description | style="width: 42px;" | size | style="width: 66px;" | | style="width: 379px;" | Description string |- | style="width: 103px;" | List of articles… | style="width: 42px;" | | style="width: 66px;" | | style="width: 379px;" | Optional (if article count > 0) |} List of articles contains: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Article ID | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Time stamp | style="width: 42px;" | 8 | style="width: 66px;" | | style="width: 379px;" | Year (2 bytes), milliseconds (2 bytes) and seconds (4 bytes) |- | style="width: 103px;" | Parent article ID | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Article flags | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Flavor count | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Title size | style="width: 42px;" | 1 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Title | style="width: 42px;" | Size | style="width: 66px;" | | style="width: 379px;" | Title string |- | style="width: 103px;" | Poster size | style="width: 42px;" | 1 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Poster | style="width: 42px;" | Size | style="width: 66px;" | | style="width: 379px;" | Poster string |- | style="width: 103px;" | Flavor list… | style="width: 42px;" | | style="width: 66px;" | | style="width: 379px;" | Optional (if flavor count > 0) |} Flavor list has the following structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Flavor size | style="width: 42px;" | 1 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Flavor text | style="width: 42px;" | size | style="width: 66px;" | | style="width: 379px;" | MIME type string |- | style="width: 103px;" | Article size | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |} '''News Category Name (322)''' Constant: myField_NewsCatName Type: String '''News Category List Data 1.5 (323)''' Constant: myField_NewsCatListData15 Type: Binary News category list data field contains this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Type | style="width: 42px;" | 2 | style="width: 66px;" | 2 or 3 | style="width: 379px;" | Bundle (2) or category (3) |} If type value indicates a bundle, what follows the type is: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Count | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Name size | style="width: 42px;" | 1 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Name data | style="width: 42px;" | size | style="width: 66px;" | | style="width: 379px;" | |} In the case of a category type, type value is followed by: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Count | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | GUID | style="width: 42px;" | | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Add SN | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Delete SN | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Name size | style="width: 42px;" | 1 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Name data | style="width: 42px;" | size | style="width: 66px;" | | style="width: 379px;" | |} '''News Path (325)''' Constant: myField_NewsPath Type: Binary '''News Article ID (326)''' Constant: myField_NewsArtID Type: Integer '''News Article Data Flavor (327)''' Constant: myField_NewsArtDataFlav Type: String '''News Article Title (328)''' Constant: myField_NewsArtTitle Type: String '''News Article Poster (329)''' Constant: myField_NewsArtPoster Type: String '''News Article Date (330)''' Constant: myField_NewsArtDate Type: Binary News article date field contains this structure: {| border="1" cellpadding="0" cellspacing="0" | style="width: 103px;" | Description | style="width: 42px;" | Size | style="width: 66px;" | Data | style="width: 379px;" | Note |- | style="width: 103px;" | Year | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Milliseconds | style="width: 42px;" | 2 | style="width: 66px;" | | style="width: 379px;" | |- | style="width: 103px;" | Seconds | style="width: 42px;" | 4 | style="width: 66px;" | | style="width: 379px;" | |} See [[Date Parameters]] for more info. '''News Article – Previous Article (331)''' Constant: myField_NewsArtPrevArt Type: Integer '''News Article – Next Article (332)''' Constant: myField_NewsArtNextArt Type: Integer '''News Article Data (333)''' Constant: myField_NewsArtData Type: Binary '''News Article Flags (334)''' Constant: myField_NewsArtFlags Type: Integer '''News Article – Parent Article (335)''' Constant: myField_NewsArtParentArt Type: Integer '''News Article – First Child Article (336)''' Constant: myField_NewsArt1stChildArt Type: Integer '''News Article – Recursive Delete (337)''' (Delete Children) Constant: myField_NewsArtRecurseDel Type: Integer
Summary:
Please note that all contributions to Hotline Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
HL Wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
Edit source
View history
More
Navigation
Home
Clients
Servers
Trackers
Development
Recent Changes
discord
Our Discord(BNETcc)
Macintosh Garden
partners
Macintosh Garden
BNET.cc
Moghouse
Tools
What links here
Related changes
Special pages
Page information