## Printer Device Driver

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

### GplStringSorterRemoveStrings

Description

This function is used to delete all strings from the string sorter instance , based on a relationship (ulOption) to a rectangle (rectlBand) both passed .

See StringGetFirstStringFromSorter() and StringGetNextStringFromSorter() calls for non-destructive string retrievals.

Remove options include:

Option Description

STR_INCL_PART_IN_BAND Return any string whose text box intersects any part of the band passed in.

STR_INCL_ALL_IN_BAND Return any string whose text box is entirely inside the band passed in.

STR_INCL_TOPLEFT_IN_BAND Return any string whose top-left coordinate is inside the band passed in.

Removes are inclusive on all sides of rectlBand passed in.

Format

    APIRET APIENTRY GplStringSorterRemoveStrings( HSORTER  hStrSort,

                                                  ULONG    ulOption,

                                                  RECTL    rectlBand );

Parameters

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

ulOption (ULONG) Remove options.

rectlBand (RECTL) Rectangle that is used for comparison by the remove option.

Returns

Success NO_ERROR
Failure ERROR_xxx