FreeImage.GetLockedPageNumbers Method

FreeImage.NET

previous page next page

FreeImage.NET Class Library Reference

FreeImageGetLockedPageNumbers Method

Returns an array of page-numbers that are currently locked in memory. When the pages parameter is null, the size of the array is returned in the count variable.

Namespace: FreeImageAPI
Assembly: FreeImageNET (in FreeImageNET.dll) Version: 3.17.0.4 (3.17.0)

Syntax

Copy

public static bool GetLockedPageNumbers(
	FIMULTIBITMAP bitmap,
	int[] pages,
	ref int count
)

Parameters

bitmap: Type: FreeImageAPIFIMULTIBITMAP
Handle to a FreeImage multi-paged bitmap.
pages: Type: SystemInt32
The list of locked pages in the multi-pages bitmap. If set to null, count will contain the number of pages.
count: Type: SystemInt32
If pages is set to null count will contain the number of locked pages.

Return Value

Type: Boolean
Returns true on success, false on failure.

Examples

Copy

int[] lockedPages = null;
int count = 0;
GetLockedPageNumbers(dib, lockedPages, ref count);
lockedPages = new int[count];
GetLockedPageNumbers(dib, lockedPages, ref count);

Reference

FreeImage Class

FreeImageAPI Namespace

Contact/Feedback: FreeImage.NET Homepage
Help improve this Documentation: Join the Project

previous page start next page