## Printer Device Driver

[prev][next][parent][TOC]

### GplStringSorterInsertString

Description

This function adds a text string to a string instance. Information, including the bounding rectangle passed in and a pointer to the data, is stored with the string. You can store with the string (for example, a pointer to a structure containing font name, font ID, and color).

Currently, the sort order is determined by the top-left corner of the text box passed in. The strings are sorted in page order. Page order is the order the text would be printed by a banding device on a hardcopy page.

Format

    APIRET APIENTRY GplStringSorterInsertString( HSORTER  hStrSort,

                                                 PSZ      pszStr,

                                                 RECTL    rectlStr,

                                                 PVOID    pUserDef,

                                                 PVOID    pUnused );

Parameters

hStrSort (HSORTER) Handle of the string sorter to be used for insert operation.

pszStr (PSZ) Pointer to text string to insert.

rectlStr (RECTL) Bounding rectangle of string being inserted.

pUserDef (PVOID) Pointer to user-defined data to be stored with this string .

pUnused (PVOID) NULL. Reserved for future use.

Returns

Success NO_ERROR
Failure ERROR_INVALID_PARAMETER
ERROR_xxx