PrApi: DecodeLatentImage

DecodeLatentImage

Decodes a latent image from a stored image.

 Public Function DecodeLatentImage(
	  ByVal page As Long,
	  ByVal light As Long,
	  ByVal type_ As Long,
	  ByVal decpar As String ) As Long

Parameters

page
The actual page of the image.
light
The light settings. The possible values are defined in the PR_LIGHT enumeration.
type_
The type of the image. It must be PR_IT_ORIGINAL.
decpar
Decoding parameter.

Return Values

The latent image.

Languages

[Visual Basic] Public Function DecodeLatentImage(ByVal page As Long, ByVal light As Long, ByVal type_ As Long, ByVal decpar As String) As Long

[Delphi] function DecodeLatentImage(page: Integer; light: Integer; type_: Integer; decpar: WideString): Integer;

[C++] long DecodeLatentImage(long page, long light, long type_, BSTR decpar);

Remarks

The returned image reference can be feed to a GxVariantOCX control, or it can be passed to a GxImage control by its GetFromGxVariant method.
It is important that this value is not a simple integer but it represents a complex internal data which is referenced internally each time it is accessed. So do use it carefully (do not convert to / or compare with integers) to avoid memory leak problems.

See Also

Class PrApi Overview PrApi Properties PrApi Methods ConvertRfFileId DisconnectRfidCard