PrApi: GetLightMask

GetLightMask

Returns a light mask for a given light and window.

 Public Function GetLightMask(
	  ByVal light_id As Long,
	  ByVal window_id As Long ) As Long

Parameters

light_id
The id of the interesting light. The possible values are definied in PR_LIGHT enumeration. If this value is null the fuction returns the whole light mask of the given object window.
window_id
The id of the object window. The possible values are definied in the PR_WINDOW_ID enumeration. If the value is PR_OW_DEFAULT (null) the fuction returns the light mask of the device.

Return Values

The light mask.

Languages

[Visual Basic] Public Function GetLightMask(ByVal light_id As Long, ByVal window_id As Long) As Long

[Delphi] function GetLightMask(light_id: Integer; window_id: Integer): Integer;

[C++] long GetLightMask(long light_id, long window_id);

Remarks

It can be used to test if the a light is available for the device or one of its object windows. It may return the whole light mask for a given object window if the light_id is null. Light masks are used by the SetPageLight() method.

See Also

Class PrApi Overview PrApi Properties PrApi Methods GetLicenses GetMrz