Data type for custom human readable text drawing callback-function.
This callback function can be set with BCSetFuncDrawText(). When set the drawing functions such as BCDraw(), BCPostscriptToFile, BCPCLToFile() etc. do not generate any output. Instead they call the active callback function.
When Windows-GDI drawing is started (with BCDraw()) then drawDC contains the Windows device contexts (if set). The variables x, and y specify the position of the barcode text. If drawDC and targetDC are not set then these variables are given in millimeters, where the origin of the coordinate system is the upper, left coordinate of the barcode. The positive X-axis points to the right and the positive Y-axis points downwards.
If drawDC or targetDC are set then the parameters x and y use the current logical coordinate system and the logical units of these device contexts.
- Note:
- The user-defined data (customData) is shared by all callback functions.
- Parameters:
-
| [in,out] | customData | User-defined data. |
| [in,out] | drawDC | The device context. |
| [in] | font | The LOGFONTA structure that defines the font. |
| [in] | x | The x-coordinate of the text. Depending on the alignment, the x specifies either the left, the center or the right coordinate of the text. |
| [in] | y | The top coordinate of the text. |
| [in] | alignment | The horizontal alignment of the text. (The vertical alignment is always 'top'.) |
| [in] | text | The output string. |
| [in] | numberOfCharacters | The number of characters in text. |
| [in] | drawArea | The draw area for the text. |
| [in] | textIndex | The index of given text. 0 ... means that given text is the human readable text. >0 ... means that given text is the extra text with given index [1 .. n]. |
- Return values:
-
| ErrOk | Everything went fine, and the drawing continues. |
| !=ErrOk | Something went wrong, the drawing function returns with the returned error value. |
- See also:
- BCGetFuncDrawText(), BCSetFuncDrawText(), BCDrawCB()
