3.1.4.1.2 OWSCA Structure
The OWSCA structure is a variable-length structure that is used to pass information between the protocol client and the protocol server. It has the following structure:
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
OWSCAType |
|||||||||||||||||||||||||||||||
|
VT_Type |
Payload (variable) |
||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
OWSCAType (4 bytes): An unsigned integer value specifying the type of the OWSCA structure. The OWSCAType value MUST be one of the following values:
|
Name |
Value |
Associated VT_Type |
Meaning |
|---|---|---|---|
|
OWSCA_ID |
0 |
3 |
The identifier of the Web discussion comment. |
|
OWSCA_PARENTID |
1 |
3 |
The identifier of the parent Web discussion comment of the Web discussion comment. |
|
OWSCA_STATUS |
6 |
2 |
The visibility status of the Web discussion comment. |
|
OWSCA_COMMENTID |
9 |
8 |
An application-specific string, or tag, that is associated with the Web discussion comment. |
|
OWSCA_BOOKMARK |
10 |
8 |
A discussion bookmark for the Web discussion comment in the document. |
|
OWSCA_AUTHOR |
11 |
8 |
The author of the Web discussion comment. |
|
OWSCA_LOGINNAME |
12 |
8 |
The login name of the author of the Web discussion comment. |
|
OWSCA_SUBJECT |
13 |
8 |
The subject of the Web discussion comment. |
|
OWSCA_TIMESTAMP |
14 |
7 |
The creation date and time of the Web discussion comment. |
|
OWSCA_COMMENT |
15 |
8 |
The comment for the Web discussion comment. |
VT_Type (2 bytes): An unsigned integer value specifying the type of data in the OWSCA structure. The value MUST be the "VT_Type" value that is associated with the OWSCAType in the preceding table, and MUST be one of the following values:
|
VT_Type |
Payload |
|---|---|
|
2 |
A 16-bit integer serialized in little-endian format. |
|
3 |
A 32-bit integer serialized in little-endian format. |
|
7 |
A date and time value, serialized as a double. |
|
8 |
A NULL terminated UTF-16 string, prefixed by its length in bytes. The first 4 bytes of the string stores an integer that is the length, in bytes, of the following string. If the string is not NULL terminated, the last byte of the string MUST be ignored by the protocol server. |
Payload[0…n] (variable): The value of the property, whose type is specified by VT_TYPE and whose format is specified in the preceding table.
The OWSCA_STATUS OWSCAType enables the protocol server to specify whether a protocol client shows or hides a Web discussion comment. The Payload values for OWSCA_STATUS MUST be one of the following values:
|
Value |
Meaning |
|---|---|
|
0 |
Default value. The Web discussion comment and its replies are suggested to be shown. |
|
2 |
The Web discussion comment is suggested to be hidden. |
|
4 |
The Web discussion comment and its replies are suggested to be hidden. |
|
8 |
The Web discussion comment was hidden previously, but is now suggested to be shown. |