Index

CDTDocV8

SetParams

The pdDocSetParams function sets important Power Engine document parameters. These parameters can be used to configure certain Power Engine document features and algorithms.

Deprecation Notice: As of D-Type 8.0.1.3 this function is deprecated and might be removed in the future. This function has the same effect as the following code:

pdDocSetNumericValue(power_doc, PD_NVAL_SIZE_ORIGIN, params->SizeOrigin);
pdDocSetNumericValue(power_doc, PD_NVAL_SIZE_SELECT, params->SizeSelect);
pdDocSetNumericValue(power_doc, PD_NVAL_SIZE_CLIP_EXTEND_X, params->SizeClipExtendX);
pdDocSetNumericValue(power_doc, PD_NVAL_SIZE_CLIP_EXTEND_Y, params->SizeClipExtendY);
pdDocSetNumericValue(power_doc, PD_NVAL_CACHE_FLAG_FOR_MASKING, params->CacheFlagForMasking);
pdDocSetNumericValue(power_doc, PD_NVAL_CACHE_FLAG_FOR_GLYPHS, params->CacheFlagForGlyphs);
pdDocSetNumericValue(power_doc, PD_NVAL_CONTROL_GLYPHS, params->Reserved1);
pdDocSetNumericValue(power_doc, PD_NVAL_CONTROL_ALGORITHMS, params->Reserved2);

Modern applications should use SetNumericValue instead.

Parameters

ParameterDescription

params

A valid pointer to the DT_PD_DOC_PARAMS structure. This structure contains important run-time parameters for the specified Power Engine document. The members of this structure have the following meaning:

SizeOrigin — Same as PD_NVAL_SIZE_ORIGIN in SetNumericValue.

SizeSelect — Same as PD_NVAL_SIZE_SELECT in SetNumericValue.

SizeClipExtendX — Same as PD_NVAL_SIZE_CLIP_EXTEND_X in SetNumericValue.

SizeClipExtendY — Same as PD_NVAL_SIZE_CLIP_EXTEND_Y in SetNumericValue.

CacheFlagForMasking — Same as PD_NVAL_CACHE_FLAG_FOR_MASKING in SetNumericValue.

CacheFlagForGlyphs — Same as PD_NVAL_CACHE_FLAG_FOR_GLYPHS in SetNumericValue.

Reserved1 — Same as PD_NVAL_CONTROL_GLYPHS in SetNumericValue.

Reserved2 — Same as PD_NVAL_CONTROL_ALGORITHMS in SetNumericValue.

reserved

Reserved for future use. Must be set to 0.

Return Value

If successful, the return value is 1. Otherwise, the function returns 0.

Note 1

For more information on Power Engine's caching subsystem, see the EngineSetParams function.



 

Index