CopyImage

CopyImage()

Syntax

Result = CopyImage(#Image1, #Image2)

Description

Creates an identical copy of an image. If the image is multi-frame, the current frame will be used for the copy.

Parameters

#Image1 The source image.

#Image2 A number to identify the new copy. #PB_Any can be specified to auto-generate this number.

Note: The number of an existing image created using #PB_Any can not be used as the target image. Instead, the existing image must be freed and a new number generated by passing #PB_Any here.

Return value

Returns nonzero if the image was copied successfully and zero if the copy could not be created. If #PB_Any was specified as the #Image2 parameter then the auto-generated number is returned on success.

See Also

GrabImage(), FreeImage()

Supported OS

All

<- CatchImage() - Image Index - CreateImage() ->

#Image1	The source image.
#Image2	A number to identify the new copy. #PB_Any can be specified to auto-generate this number. Note: The number of an existing image created using #PB_Any can not be used as the target image. Instead, the existing image must be freed and a new number generated by passing #PB_Any here.