Index

C/C++ Functions

pdDocGetParams

DT_SWORD pdDocGetParams(DT_PDDOC power_doc, DT_PD_DOC_PARAMS* params, DT_SLONG reserved)

Short Description: Get document parameters

The pdDocGetParams function returns current Power Engine document parameters. These parameters are normally set by pdDocSetParams.

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:

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

Modern applications should use pdDocGetNumericValue instead.

Parameters

ParameterDescription

power_doc

Handle of the previously created Power Engine document.

params

A valid pointer to the DT_PD_DOC_PARAMS structure that will receive Power Engine document's active parameters. See pdDocSetParams for details.

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

pdDocSetParams

 

Index