The GetPageCalibration transaction returns the calibrated scale factor for the page. Calibration is used when measurements returned based on the image resolution are not accurate. For example, you may know that an image line is 1.5 inches long, but the value returned when you use the Measure tool on it is 3 inches. In that case you could calibrate the page by a scale factor of 0.5.
Type XTYP_REQUEST
Syntax [GetPageCalibration(docwinID, pageID)]
|
Parameter |
Data type |
Values |
Meaning |
|
docwinID |
DWORD |
0 | docwinID |
active | specific |
|
pageID |
DWORD |
0 | pageID |
current | specific |
|
Reply |
Data type |
Values |
Meaning |
|
bSet |
BOOL |
0 | 1 |
no calibration | calibration set |
|
scaleFactor |
float |
calibrated scale factor (if any) | |
|
units |
WORD |
1 |
inches |
|
|
|
2 |
cm |
|
|
|
3 |
pixels |
|
|
|
4 |
feet |
|
|
|
5 |
mm |
|
|
|
6 |
m |
|
|
|
7 |
points |
|
|
|
8 |
twips |
|
|
|
9 | 10 | 11 |
custom 1 | 2 | 3 |
|
|
|
12 |
default |
Remarks
The scaleFactor and units replies are only returned when the bSet reply equals 1.
Release information
Added in Release 4.31.
See also