Index

C/C++ Functions

pdDocSetParams

DT_SWORD pdDocSetParams(DT_PDDOC power_doc, const DT_PD_DOC_PARAMS* params, DT_SLONG reserved)

Short Description: Set document parameters

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 pdDocSetNumericValue instead.

Parameters

ParameterDescription

power_doc

Handle of the associated Power Engine document.

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 pdDocSetNumericValue.

SizeSelect — Same as PD_NVAL_SIZE_SELECT in pdDocSetNumericValue.

SizeClipExtendX — Same as PD_NVAL_SIZE_CLIP_EXTEND_X in pdDocSetNumericValue.

SizeClipExtendY — Same as PD_NVAL_SIZE_CLIP_EXTEND_Y in pdDocSetNumericValue.

CacheFlagForMasking — Same as PD_NVAL_CACHE_FLAG_FOR_MASKING in pdDocSetNumericValue.

CacheFlagForGlyphs — Same as PD_NVAL_CACHE_FLAG_FOR_GLYPHS in pdDocSetNumericValue.

Reserved1 — Same as PD_NVAL_CONTROL_GLYPHS in pdDocSetNumericValue.

Reserved2 — Same as PD_NVAL_CONTROL_ALGORITHMS in pdDocSetNumericValue.

reserved

Reserved for future use. Must be set to 0.

Return Value

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

Related Functions

pdDocGetParams

Note 1

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

 

Index