DBreturnTextSettings

Top  Previous  Next

Information about a text delivers.

With this procedure the settings of a text element are determined. The real text is able to come DBreturnTextString or DBreturnExpandedText are determined. The settings become from this procedure in one, from the user provided record written. The pointer settings must point already by the call of the procedure at a valid storage area. As an input DBreturnTextSettings receives furthermore the trading of the text element whose values should be read. Now, in addition, can be calculated also the Boundingbox which surrounds the text. To carry out the Boundingboxberechnung, must be given as the value 2 grades. The values which are put down with step 1 are also inserted with step 2.

Parametre

element (PTEXT_ELEMENT) [IN]

This is the trading of the text element whose values are needed.

settings (TEXT_SETTINGS *) [IN / OUT]

By procedure entry this pointer points at a valid storage area of the size of the structure TEXT_SETTINGS. The area must not be initialized. The procedure fills this structure with the parametres about element of certain text element.

grade (int) [IN]

Possible values are 1 and 2.

With step 1 information about the text is determined. This information concerns the text height, now text kind, shading etc. with the step 2 can be calculated, in addition, also the Boundingbox which surrounds the text. The calculation also encloses the cases that the text is put in italics, concentric, on the left or flush right.

Result

(T_ERROR) [OUT]

By successful implementation the procedure delivers the value ERROR_OK, the other mistakes can be taken from the file error.h.

Declaration

#include "database.h"

 

T_ERROR DLLENTRY DBreturnTextSettings (

PTEXT_ELEMENT element,

TEXT_SETTINGS * settings,

int grades

);