The txTextGetParams function returns current Power Engine document parameters. These parameters are normally set by txTextSetParams.
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->EnableBits = txTextGetNumericValue(text_doc, TX_NVAL_ENABLE_BITS); params->ConfigBits = txTextGetNumericValue(text_doc, TX_NVAL_CONFIG_BITS); DT_PDDOC power_doc; txTextGetPowerDoc(text_doc, &power_doc); DT_PD_DOC_PARAMS extra; pdDocGetParams(power_doc, &extra, 0); params->Extra = &extra;
which is the same as:
params->EnableBits = txTextGetNumericValue(text_doc, TX_NVAL_ENABLE_BITS); params->ConfigBits = txTextGetNumericValue(text_doc, TX_NVAL_CONFIG_BITS); DT_PDDOC power_doc; txTextGetPowerDoc(text_doc, &power_doc); DT_PD_DOC_PARAMS extra; extra->SizeOrigin = pdDocGetNumericValue(power_doc, PD_NVAL_SIZE_ORIGIN); extra->SizeSelect = pdDocGetNumericValue(power_doc, PD_NVAL_SIZE_SELECT); extra->SizeClipExtendX = pdDocGetNumericValue(power_doc, PD_NVAL_SIZE_CLIP_EXTEND_X); extra->SizeClipExtendY = pdDocGetNumericValue(power_doc, PD_NVAL_SIZE_CLIP_EXTEND_Y); extra->CacheFlagForMasking = pdDocGetNumericValue(power_doc, PD_NVAL_CACHE_FLAG_FOR_MASKING); extra->CacheFlagForGlyphs = pdDocGetNumericValue(power_doc, PD_NVAL_CACHE_FLAG_FOR_GLYPHS); extra->Reserved1 = pdDocGetNumericValue(power_doc, PD_NVAL_CONTROL_GLYPHS); extra->Reserved2 = pdDocGetNumericValue(power_doc, PD_NVAL_CONTROL_ALGORITHMS); params->Extra = &extra;
Modern applications should use txTextGetNumericValue and pdDocGetNumericValue instead.
Parameter | Description |
---|---|
text_doc |
Handle of the associated text document instance. |
params |
A valid pointer to the DT_TX_DOC_PARAMS structure that will receive text document's active parameters. See txTextSetParams for details. |
reserved |
Reserved for future use. Must be set to 0. |
If successful, the return value is 1. Otherwise, the function returns 0.