2.11.1 DocRoutingSlipAtom
Referenced by: DocumentContainer
An atom record that specifies information about a document routing slip.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
rh |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
length |
|||||||||||||||||||||||||||||||
|
unused1 |
|||||||||||||||||||||||||||||||
|
recipientCount |
|||||||||||||||||||||||||||||||
|
currentRecipient |
|||||||||||||||||||||||||||||||
|
A |
B |
C |
D |
E |
F |
reserved2 |
|||||||||||||||||||||||||
|
unused2 |
|||||||||||||||||||||||||||||||
|
originatorString (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
rgRecipientRoutingSlipStrings (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
subjectString (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
messageString (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
unused3 (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
rh (8 bytes): A RecordHeader structure (section 2.3.1) that specifies the header for this record. Sub-fields are further specified in the following table.
-
Field
Meaning
rh.recVer
MUST be 0x0.
rh.recInstance
MUST be 0x000.
rh.recType
MUST be an RT_DocRoutingSlipAtom.
length (4 bytes): An unsigned integer that specifies the length, in bytes, of the data contained in the document routing slip, including this field. It MUST be less than or equal to rh.recLen.
unused1 (4 bytes): Undefined and MUST be ignored.
recipientCount (4 bytes): An unsigned integer that specifies the count of strings in the collection of recipients specified by rgRecipientRoutingSlipStrings.
currentRecipient (4 bytes): An unsigned integer that specifies the addressee of the document routing slip. It MUST be less than or equal to recipientCount+1. A value of 0x00000000 or a value of recipientCount+1 specifies the originator identified by originatorString. A value greater than 0x00000000 and less than recipientCount+1 specifies a 1-based index into the collection of recipients specified by rgRecipientRoutingSlipStrings.
A - fOneAfterAnother (1 bit): A bit that specifies how a document is sent to recipients. It MUST be a value from the following table.
-
Value
Meaning
FALSE
The document is sent from the originator to all recipients simultaneously.
TRUE
The document is sent sequentially to one recipient after another. After a recipient is finished processing the document, the document is sent to the next recipient.
B - fReturnWhenDone (1 bit): A bit that specifies whether a document is sent back to the originator after all recipients have processed the document.
C - fTrackStatus (1 bit): A bit that specifies whether progress of a document routing slip is tracked. If progress is tracked, the originator is notified after a recipient finishes processing the document.
D - reserved1 (1 bit): MUST be zero, and MUST be ignored.
E - fDocumentRouted (1 bit): A bit that specifies whether the document-routing is in progress and the document is being processed by recipients.
F - fCycleCompleted (1 bit): A bit that specifies whether all recipients have finished processing the document.
reserved2 (26 bits): MUST be ignored and MUST be 0.
unused2 (4 bytes): Undefined and MUST be ignored.
originatorString (variable): A DocRoutingSlipString structure that specifies the originator of a document routing slip. The originatorString.stringType field MUST be 0x0001.
rgRecipientRoutingSlipStrings (variable): An array of DocRoutingSlipString structures that specifies recipients of a document routing slip. The count of items in the array is specified by recipientCount. The stringType field of each DocRoutingSlipString item MUST be 0x0002.
subjectString (variable): A DocRoutingSlipString structure that specifies the subject of a document routing slip. The subjectString.stringType field MUST be 0x0003.
messageString (variable): A DocRoutingSlipString structure that specifies the message of a document routing slip. The messageString.stringType field MUST be 0x0004.
unused3 (variable): Undefined and MUST be ignored. The length, in bytes, of the field is specified by the following formula:
-
8 + rh.recLen – length