2.9.205 Pms

The Pms data structure contains the print merge or mail merge state information.


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

wpms

ipmfMF

ipmfFetch

iRecCur

rgpmfs (16 bytes)

...

...

rfs

cblszSqlStr

lxszSqlStr (variable)

...

sttbfRfs (variable)

...

wpmsdt (optional)

wpms (2 bytes): The mail merge state as a Wpms.

ipmfMF (1 byte): An unsigned integer that specifies the index in the array rgpmfs and MUST be 0 or 1. This value is used for the mail merge header field source from which the mail merge column names are obtained.

ipmfFetch (1 byte):  An unsigned integer that specifies the index in the array rgpmfs and MUST be 0 or 1. This value is used for the mail merge data fetch source from which the mail merge data is obtained.

iRecCur (4 bytes): An unsigned integer that specifies the index of the current mail merge record. This value MUST be between 0 and 0xFFFFFFF0 as the record index, or it MUST be 0xFFFFFFFF as a nil value.

rgpmfs (16 bytes): An array of two Pmfs elements.

rfs (4 bytes): The mail merge record filtering information. See Rfs.

cblszSqlStr (2 bytes): An unsigned integer that specifies the length, in bytes, of the string lxszSqlStr. Because lxszSqlStr is in Unicode, cblszSqlStr MUST be an even number. If cblszSqlStr is zero, lxszSqlStr does not exist; otherwise this value MUST be greater than 2 but MUST NOT exceed 512 bytes.

lxszSqlStr (variable): The null-terminated Unicode SQL Query string. For example, "SELECT * FROM [myTable] WHERE …", where myTable is the table name in the database that is connected. This field is not present if cblszSqlStr is zero.

sttbfRfs (variable): The string table, STTB, that contains the strings for mail merge connection and record filtering. See the SttbfRfs structure. Pms.sttbfRfs does not exist if Pms.rfs.hsttbRfs is zero. See the Rfs structure.

wpmsdt (4 bytes): The mail merge document type. See the Wpmsdt structure.