GpiEndInkPath

This is an undocumented function.

GpiEndInkPath is the API used to terminate the current inking path session that was initiated by GpiBeginInkPath.

When you call this function, it effectively closes the "ink path bracket" and provides instructions to the graphics subsystem on what to do with the ink currently displayed on the screen.

Syntax

GpiEndInkPath (hps, flOptions)

Parameters

hps (HPS) - input

The handle to the InkPS.

flOptions (ULONG) - input

The options

The options specify whether to erase the ink path from the screen or to keep it there

The PPE_KEEPPATH option is the default and is the only option available for most foreground mix attributes

Both options, PPE_KEEPPATH and PPE_ERASEPATH, are available if the foreground mix attribute is set to either FM_XOR or FM_INVERT.

Returns

rc (BOOL) - return

TRUE (or a non-zero value)

Indicates that the function successfully terminated the ink path.

FALSE (or zero)

Indicates that the function failed.