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)

Syntax

C#
public static bool GetLockedPageNumbers(
	FIMULTIBITMAP bitmap,
	int[] pages,
	ref int count
)
Visual Basic (Declaration)
Public Shared Function GetLockedPageNumbers ( _
	bitmap As FIMULTIBITMAP, _
	pages As Integer(), _
	ByRef count As Integer _
) As Boolean
Visual C++
public:
static bool GetLockedPageNumbers(
	FIMULTIBITMAP bitmap, 
	array<int>^ pages, 
	int% count
)

Parameters

bitmap
Type: FreeImageAPI..::.FIMULTIBITMAP
Handle to a FreeImage multi-paged bitmap.
pages
Type: array< System..::.Int32 >[]()[]
The list of locked pages in the multi-pages bitmap. If set to null, count will contain the number of pages.
count
Type: System..::.Int32 %
If pages is set to null count will contain the number of locked pages.

Return Value

Returns true on success, false on failure.

Examples

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

Version Information

FreeImage.NET

Supported in: 3.11.0, 3.12.0, 3.13.0, 3.13.1

See Also