2.9.232 RouteSlip

The RouteSlip structure contains information about the routing slip of the document.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

fRouted

fReturnOrig

fTrackStatus

fDirty

nProtect

iStage

delOption

cRecip

szSubject (variable)

...

szMessage (variable)

...

szStatus (variable)

...

szTitle (variable)

...

rgRouteSlips (variable)

...

fRouted (2 bytes):  A 16-bit Boolean value that specifies whether the document was sent out for review.

fReturnOrig (2 bytes):  A 16-bit Boolean value that specifies whether the document is returned to the original sender after the review route is complete.

fTrackStatus (2 bytes):  A 16-bit Boolean value that specifies whether status tracking e-mail is sent to the original sender.

fDirty (2 bytes): This value MUST be 0, and MUST be ignored.

nProtect (2 bytes):  An unsigned integer value that specifies the kinds of changes allowed to the document being routed. This MUST be one of the values that are defined in RouteSlipProtectionEnum.

iStage (2 bytes): A 16-bit signed integer value that specifies the index of the current routing recipient. This value MUST be greater or equal to zero, and less than the value of cRecip.

delOption (2 bytes): A 16-bit signed integer value that specifies how the document is routed. This value MUST be 0 or 1. A value of 0 means the document is sent to reviewers in serial order. A value of 1 means the document is sent to all reviewers in parallel order.

cRecip (2 bytes): A 16-bit signed integer that specifies the number of recipients of the routing slip. This is the size of the rgRouteSlips array. This value MUST be greater than or equal to zero.

szSubject (variable):  A string with a length prefix of 2 bytes containing ANSI characters that represent the subject to be mailed with the route slip. This string MUST be less than 256 characters in length. The string is encoded by using the system code page of the computer that saved the file.

szMessage (variable):  A string with a length prefix of 2 bytes containing ANSI characters that represent the message body to be mailed with the route slip. This string MUST be less than 256 characters in length. The string is encoded by using the system code page of the computer that saved the file.

szStatus (variable):  A string with a length prefix of 2 bytes containing ANSI characters that represent status information about the document to be mailed with the route slip. This string MUST be less than 256 characters in length. The string is encoded by using the system code page of the computer that saved the file.

szTitle (variable):  A string with a length prefix of 2 bytes containing ANSI characters that represent a title for the route slip. This string MUST be less than 256 characters long. The string is encoded by using the system code page of the computer that saved the file.

rgRouteSlips (variable): An array of cRecip RouteSlipInfo structures that contains all the routing slips.