A unique image identifier of the GdPicture image representing the multipage TIFF image.





In This Topic
GdPicture14 Namespace / GdPictureImaging Class / TiffGetCurrentPage Method

TiffGetCurrentPage Method (GdPictureImaging)

In This Topic
Returns the page number of the currently selected page within the specified multipage TIFF image represented by its unique image identifier.

This method only handles multipage TIFF images, both editable or opened as read-only.

Syntax
'Declaration
 
Public Function TiffGetCurrentPage( _
   ByVal ImageID As Integer _
) As Integer
public int TiffGetCurrentPage( 
   int ImageID
)
public function TiffGetCurrentPage( 
    ImageID: Integer
): Integer; 
public function TiffGetCurrentPage( 
   ImageID : int
) : int;
public: int TiffGetCurrentPage( 
   int ImageID
) 
public:
int TiffGetCurrentPage( 
   int ImageID
) 

Parameters

ImageID
A unique image identifier of the GdPicture image representing the multipage TIFF image.

Return Value

The page number of the currently selected page in the specified multipage TIFF image. It is a value from 1 to TiffGetPageCount or 0 if no page is selected.

The GetStat method can be subsequently used to determine if this method has been successful.

Remarks
It is recommend to use the GetStat method to identify the specific reason for the method's failure, if any.

Be aware that this method only supports multipage TIFF images, both editable or opened as read-only. If the specified image is not a multipage image, this method will fail.

See Also