L_AutGetPaintBkColor

#include ltaut.h

L_LTAUT_API L_INT L_AutGetPaintBkColor (pAutomation, prcBKColor )

pAUTOMATIONHANDLE pAutomation;

/* pointer to an automation handle */

COLORREF * prcBKColor;

/* pointer to a variable to be updated */

Gets the digital paint automation background color.

Parameter

Description

pAutomation

Pointer to an automation handle.

prcBKColor

Pointer to a COLORREF variable to be updated with the current digital paint automation background color.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Note:

This function is only available in the Digital Paint toolkits.

This function will only work if the automation handle was created using the AUTOMATION_MODE_PAINT automation mode. For information on creating an automation handle, refer to L_AutCreate.

The default color retrieved by this function is RGB (0, 0, 0).

Required DLLs and Libraries

LTAUT

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

See Also

Functions:

L_AutSetPaintBkColor.

Topics:

Automation Functions: Automation Paint Property.

Example

For an example, refer to L_AutSetPaintBkColor