Actions

Difference between revisions of "Read"

From XnView Wiki

(Created page with 'gflGetDefaultLoadParams The gflGetDefaultLoadParams function sets the GFL_LOAD_PARAMS structure with default values. To use before call of gflLoadBitmap. void gflGetDefaultLo…')
 
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
gflGetDefaultLoadParams
== gflGetDefaultLoadParams ==


The gflGetDefaultLoadParams function sets the GFL_LOAD_PARAMS structure with default values. To use before call of gflLoadBitmap.  
The gflGetDefaultLoadParams function sets the [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure with default values. Must be called before gflLoadBitmap*.  


void <b>gflGetDefaultLoadParams</b>(
  GFL_LOAD_PARAMS* load_params
);


void gflGetDefaultLoadParams(
'''Parameters'''
  GFL_LOAD_PARAMS * load_params
);


Parameters
:load_params
::Pointer to a [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure.


load_params
'''See also'''
Pointer to a GFL_LOAD_PARAMS structure.
:[[#gflGetDefaultThumbnailParams|gflGetDefaultThumbnailParams]], [[#gflLoadBitmap|gflLoadBitmap]], [[#gflLoadBitmapFromHandle|gflLoadBitmapFromHandle]], [[#gflLoadBitmapFromMemory|gflLoadBitmapFromMemory]]


See also


gflGetDefaultThumbnailParams, gflGetDefaultSaveParams, gflLoadBitmap, gflLoadBitmapFromHandle,
== gflLoadBitmap ==


gflLoadBitmap
The gflLoadBitmap function loads a picture file into memory.


The gflLoadBitmap function load a picture file into memory.
GFL_ERROR <b>gflLoadBitmap</b>(
  const char* filename, 
  GFL_BITMAP** bitmap, 
  const GFL_LOAD_PARAMS* params, 
  GFL_FILE_INFORMATION * informations
);


'''Parameters'''


GFL_ERROR gflLoadBitmap(
:filename
  const char * filename, 
::Pointer to a null-terminated string that contains the filename to load.
  GFL_BITMAP ** bitmap, 
:bitmap
  GFL_LOAD_PARAMS * params, 
::Address of a pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.
  GFL_FILE_INFORMATION * informations, 
:params
);
::Pointer to a [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure.
::This structure must be filled correctly.
:informations
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure. Can be NULL if you don't want it.
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


Parameters
'''Remark'''
:gflLoadBitmapW exists for the windows unicode version of GFLSDK


filename
'''See also'''
Pointer to a null-terminated string that contains the filename to load.
:[[#gflGetDefaultLoadParams|gflGetDefaultLoadParams]], [[#gflLoadBitmapFromMemory|gflLoadBitmapFromMemory]], [[#gflLoadBitmapFromHandle|gflLoadBitmapFromHandle]]
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeInformation to free his content.


Return value
== gflLoadBitmapFromMemory ==


The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.  
The gflLoadBitmapFromMemory function loads a picture from memory.  


GFL_ERROR <b>gflLoadBitmapFromMemory</b>(
  const GFL_UINT8* data, 
  GFL_UINT32 data_length, 
  GFL_BITMAP** bitmap, 
  const GFL_LOAD_PARAMS* params, 
  GFL_FILE_INFORMATION* informations, 
);


See also
'''Parameters'''


gflGetDefaultLoadParams, gflGetDefaultThumbnailParams, gflGetDefaultSaveParams, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle, gflLoadThumbnail, gflLoadThumbnailFromMemory, gflLoadThumbnailFromHandle, gflSaveBitmap, gflSaveBitmapIntoMemory, gflSaveBitmapIntoHandle
:data
::Pointer to the picture.
:data_length
::Length of data.
:bitmap
::Address of a pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.
:params
::Pointer to a [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure.
::This structure must be filled correctly.
:informations
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure. Can be NULL if you don't want it.
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.


'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


gflLoadBitmapFromMemory
'''See also'''
:[[#gflGetDefaultLoadParams|gflGetDefaultLoadParams]], [[#gflLoadBitmap|gflLoadBitmap]], [[#gflLoadBitmapFromHandle|gflLoadBitmapFromHandle]]


The gflLoadBitmapFromMemory function load a picture from memory.
== gflLoadBitmapFromHandle ==


The gflLoadBitmapFromHandle function loads a picture into memory with the use of read callback functions.


GFL_ERROR gflLoadBitmapFromMemory(
GFL_ERROR <b>gflLoadBitmapFromHandle</b>(
  GFL_UINT8 * data, 
  GFL_HANDLE handle,   
  GFL_UINT32 data_length,   
  GFL_BITMAP** bitmap,   
  GFL_BITMAP ** bitmap,   
  const GFL_LOAD_PARAMS* params,   
  GFL_LOAD_PARAMS * params,   
  GFL_FILE_INFORMATION* informations,   
  GFL_FILE_INFORMATION * informations,   
);
);


Parameters  
'''Parameters'''


data
:handle
Pointer to the picture.  
::User handle. The Callbacks field of the [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure must be filled correctly.  
data_length
:bitmap  
Length of data.  
::Address of a pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.  
bitmap  
:params  
Address of a pointer to a GFL_BITMAP structure.  
::Pointer to a [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure.  
params  
::This structure must be filled correctly.  
Pointer to a GFL_LOAD_PARAMS structure.  
:informations  
This structure must be filled correctly.  
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure. Can be NULL if you don't want it.  
informations  
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.  
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.  
You must use gflFreeInformation to free his content.  


Return value  
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
'''See also'''
:[[#gflGetDefaultLoadParams|gflGetDefaultLoadParams]], [[#gflLoadBitmap|gflLoadBitmap]], [[#gflLoadBitmapFromMemory|gflLoadBitmapFromMemory]]


== gflGetDefaultThumbnailParams==


See also
The gflGetDefaultThumbnailParams function sets the [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure with default values. Must be called before gflGetDefaultThumbnail*.


gflGetDefaultLoadParams, gflGetDefaultThumbnailParams, gflGetDefaultSaveParams, gflLoadBitmap, gflLoadBitmapFromHandle, gflLoadThumbnail, gflLoadThumbnailFromMemory, gflLoadThumbnailFromHandle, gflSaveBitmap, gflSaveBitmapIntoMemory, gflSaveBitmapIntoHandle
void <b>gflGetDefaultThumbnailParams</b>(
  GFL_LOAD_PARAMS* load_params
);


'''Parameters'''


gflLoadBitmapFromHandle
:load_params
::Pointer to a [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure.


The gflLoadBitmapFromHandle function load a picture into memory with the use of read callback functions.
'''See also'''
:[[#gflGetDefaultLoadParams|gflGetDefaultLoadParams]], [[#gflLoadThumbnail|gflLoadThumbnail]], [[#gflLoadThumbnailFromHandle|gflLoadThumbnailFromHandle]], [[#gflLoadThumbnailFromMemory|gflLoadThumbnailFromMemory]]




GFL_ERROR gflLoadBitmapFromHandle(
== gflLoadThumbnail ==
  GFL_HANDLE handle, 
  GFL_BITMAP ** bitmap, 
  GFL_LOAD_PARAMS * params, 
  GFL_FILE_INFORMATION * informations, 
);


Parameters
The gflLoadThumbnail function loads a picture file as a thumbnail into memory.


handle
GFL_ERROR <b>gflLoadThumbnail</b>(
User handle. The Callbacks field of the GFL_LOAD_PARAMS structure must be filled correctly.
  const char* filename, 
bitmap
  GFL_INT32 width, 
Address of a pointer to a GFL_BITMAP structure.
  GFL_INT32 height, 
params  
  GFL_BITMAP** bitmap, 
Pointer to a GFL_LOAD_PARAMS structure.
  const GFL_LOAD_PARAMS* params, 
This structure must be filled correctly.
  GFL_FILE_INFORMATION* informations, 
informations  
);
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeInformation to free his content.


Return value
'''Parameters'''


The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.  
:filename
::Pointer to a null-terminated string that contains the filename to load.
:width
::Width of the thumbnail.
:height
::Height of the thumbnail.
:bitmap
::Address of a pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.
:params
::Pointer to a [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure.
::This structure must be filled correctly.
:informations
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure. Can be NULL if you don't want it.
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.  


'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


See also
'''Remark'''
:gflLoadThumbnailW exists for the windows unicode version of GFLSDK


gflGetDefaultLoadParams, gflGetDefaultThumbnailParams, gflGetDefaultSaveParams, gflLoadBitmap, gflLoadBitmapFromMemory, gflLoadThumbnail, gflLoadThumbnailFromMemory, gflLoadThumbnailFromHandle, gflSaveBitmap, gflSaveBitmapIntoMemory, gflSaveBitmapIntoHandle
'''See also'''
:[[#gflGetDefaultThumbnailParams|gflGetDefaultThumbnailParams]], [[#gflLoadThumbnailFromHandle|gflLoadThumbnailFromHandle]], [[#gflLoadThumbnailFromMemory|gflLoadThumbnailFromMemory]]


== gflLoadThumbnailFromMemory ==


gflGetDefaultPreviewParams
The gflLoadThumbnailFromMemory function loads a picture file as a thumbnail from memory.


The gflGetDefaultPreviewParams function sets the GFL_LOAD_PARAMS structure with default values. To use before call of gflLoadPreview.
GFL_ERROR <b>gflLoadThumbnailFromMemory</b>(
  const GFL_UINT8* data, 
  GFL_UINT32 data_length, 
  GFL_INT32 width, 
  GFL_INT32 height, 
  GFL_BITMAP** bitmap, 
  const GFL_LOAD_PARAMS* params, 
  GFL_FILE_INFORMATION* informations, 
);


'''Parameters'''


void gflGetDefaultPreviewParams(
:data
  GFL_LOAD_PARAMS * load_params
::Pointer to the picture.
);
:data_length
::Length of data.
:width
::Width of the thumbnail.
:height
::Height of the thumbnail.
:bitmap
::Address of a pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.
:params
::Pointer to a [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure.
::This structure must be filled correctly.
:informations
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure. Can be NULL if you don't want it.
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.


Parameters
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


load_params
'''See also'''
Pointer to a GFL_LOAD_PARAMS structure.
:[[#gflGetDefaultThumbnailParams|gflGetDefaultThumbnailParams]], [[#gflLoadThumbnail|gflLoadThumbnail]], [[#gflLoadThumbnailFromHandle|gflLoadThumbnailFromHandle]]


See also
== gflLoadThumbnailFromHandle ==


gflGetDefaultLoadParams, gflGetDefaultSaveParams, gflLoadThumbnail, gflLoadThumbnailFromHandle,
The gflLoadThumbnailFromHandle function loads a picture file as a thumbnail into memory with the use of read callback functions.


GFL_ERROR <b>gflLoadThumbnailFromHandle</b>(
  GFL_HANDLE handle, 
  GFL_INT32 width, 
  GFL_INT32 height, 
  GFL_BITMAP** bitmap, 
  const GFL_LOAD_PARAMS* params, 
  GFL_FILE_INFORMATION* informations, 
);


gflLoadThumbnail
'''Parameters'''


The gflLoadThumbnail function load a picture file as a thumbnail into memory.  
:handle
::User handle. The Callbacks field of the [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure must be filled correctly.
:width
::Width of the thumbnail.
:height
::Height of the thumbnail.
:bitmap
::Address of a pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.
:params
::Pointer to a [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure.
::This structure must be filled correctly.
:informations
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure. Can be NULL if you don't want it.
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.  


'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


GFL_ERROR gflLoadThumbnail(
'''See also'''
  const char * filename,
:[[#gflGetDefaultThumbnailParams|gflGetDefaultThumbnailParams]], [[#gflLoadThumbnail|gflLoadThumbnail]], [[#gflLoadThumbnailFromMemory|gflLoadThumbnailFromMemory]]
  GFL_INT32 width,
  GFL_INT32 height, 
  GFL_BITMAP ** bitmap, 
  GFL_LOAD_PARAMS * params, 
  GFL_FILE_INFORMATION * informations, 
);


Parameters
== gflGetFileInformation ==
 
filename
Pointer to a null-terminated string that contains the filename to load.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeInformation to free his content.
 
Return value
 
The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
 
 
See also
 
gflGetDefaultLoadParams, gflGetDefaultThumbnailParams, gflGetDefaultSaveParams, gflLoadBitmap, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle, gflLoadThumbnailFromMemory, gflLoadThumbnailFromHandle, gflSaveBitmap, gflSaveBitmapIntoMemory, gflSaveBitmapIntoHandle
 
 
gflLoadThumbnailFromMemory
 
The gflLoadThumbnailFromMemory function load a picture file as a thumbnail from memory.
 
 
GFL_ERROR gflLoadThumbnailFromMemory(
  GFL_UINT8 * data, 
  GFL_UINT32 data_length, 
  GFL_INT32 width, 
  GFL_INT32 height, 
  GFL_BITMAP ** bitmap, 
  GFL_LOAD_PARAMS * params, 
  GFL_FILE_INFORMATION * informations, 
);
 
Parameters
 
data
Pointer to the picture.
data_length
Length of data.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.
 
Return value
 
The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
 
 
See also
 
gflGetDefaultLoadParams, gflGetDefaultThumbnailParams, gflGetDefaultSaveParams, gflLoadBitmap, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle, gflLoadThumbnail, gflLoadThumbnailFromHandle, gflSaveBitmap, gflSaveBitmapIntoMemory, gflSaveBitmapIntoHandle
 
 
gflLoadThumbnailFromHandle
 
The gflLoadThumbnailFromHandle function load a picture file as a thumbnail into memory with the use of read callback functions.
 
 
GFL_ERROR gflLoadThumbnailFromHandle(
  GFL_HANDLE handle, 
  GFL_INT32 width, 
  GFL_INT32 height, 
  GFL_BITMAP ** bitmap, 
  GFL_LOAD_PARAMS * params, 
  GFL_FILE_INFORMATION * informations, 
);
 
Parameters
 
handle
User handle. The Callbacks field of the GFL_LOAD_PARAMS structure must be filled correctly.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.
 
Return value
 
The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
 
 
See also
 
gflGetDefaultLoadParams, gflGetDefaultThumbnailParams, gflGetDefaultSaveParams, gflLoadBitmap, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle, gflLoadThumbnail, gflLoadThumbnailFromMemory, gflSaveBitmap, gflSaveBitmapIntoMemory, gflSaveBitmapIntoHandle
 
 
gflGetFileInformation


The gflGetFileInformation function retrieves all informations about a picture file.  
The gflGetFileInformation function retrieves all informations about a picture file.  


GFL_ERROR <b>gflGetFileInformation</b>(
  const char* filename, 
  GFL_INT32 index, 
  GFL_FILE_INFORMATION* information
);


GFL_ERROR gflGetFileInformation(
'''Parameters'''
  const char * filename, 
  GFL_INT32 index, 
  GFL_FILE_INFORMATION * information
);
 
Parameters  
 
filename
Pointer to a null-terminated string that contains the filename.
index
Index of format. -1 for automatic recognition.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.
 
Return value


The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.  
:filename
::Pointer to a null-terminated string that contains the filename.
:index
::Index of format. -1 for automatic recognition.
:information
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure.
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.  


'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


'''Remark'''
:gflGetFileInformationW exists for the windows unicode version of GFLSDK


See also  
'''See also'''
:[[#gflGetFileInformationFromMemory|gflGetFileInformationFromMemory]], [[#gflGetFileInformationFromHandle|gflGetFileInformationFromHandle]]


gflLoadBitmap, gflLoadBitmapFromHandle, gflLoadThumbnail, gflLoadThumbnailFromHandle
== gflGetFileInformationFromMemory ==
 
gflGetFileInformationFromMemory


The gflGetFileInformationFromMemory function retrieves all informations about a picture from memory.  
The gflGetFileInformationFromMemory function retrieves all informations about a picture from memory.  


GFL_ERROR <b>gflGetFileInformationFromMemory</b>(
  const GFL_UINT8* data, 
  GFL_UINT32 data_length, 
  GFL_INT32 index, 
  GFL_FILE_INFORMATION* information
);


GFL_ERROR gflGetFileInformationFromMemory(
'''Parameters'''
  GFL_UINT8 * data, 
  GFL_UINT32 data_length, 
  GFL_INT32 index, 
  GFL_FILE_INFORMATION * information
);
 
Parameters  
 
data
Pointer to the picture.
data_length
Length of data.
index
Index of format. -1 for automatic recognition.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.
 
Return value
 
The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
 


:data
::Pointer to the picture.
:data_length
::Length of data.
:index
::Index of format. -1 for automatic recognition.
:information
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure.
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.


See also
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


gflLoadBitmap, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle, gflLoadThumbnail, gflLoadThumbnailFromMemory, gflLoadThumbnailFromHandle
'''See also'''
:[[#gflGetFileInformation|gflGetFileInformation]], [[#gflGetFileInformationFromHandle|gflGetFileInformationFromHandle]]


 
== gflGetFileInformationFromHandle ==
gflGetFileInformationFromHandle


The gflGetFileInformationFromHandle function retrieves all informations about a picture with the use of read callback functions.  
The gflGetFileInformationFromHandle function retrieves all informations about a picture with the use of read callback functions.  


GFL_ERROR <b>gflGetFileInformationFromHandle</b>(
  GFL_HANDLE handle, 
  GFL_INT32 index, 
  const GFL_LOAD_CALLBACKS* callbacks, 
  GFL_FILE_INFORMATION* information
);


GFL_ERROR gflGetFileInformationFromHandle(
'''Parameters'''
  GFL_HANDLE handle, 
  GFL_INT32 index, 
  const GFL_LOAD_CALLBACKS * callbacks, 
  GFL_FILE_INFORMATION * information
);
 
Parameters  
 
handle
User handle.
index
Index of format. -1 for automatic recognition.
callbacks
Callback to access picture data.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.
 
Return value
 
The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
 


:handle
::User handle.
:index
::Index of format. -1 for automatic recognition.
:callbacks
::Pointer to a [[Structures#GFL_LOAD_CALLBACKS|GFL_LOAD_CALLBACKS]] to access picture data.
:information
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure.
::You must use [[#gflFreeFileInformation|gflFreeFileInformation]] to free his content.


See also
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


gflLoadBitmap, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle, gflLoadThumbnail, gflLoadThumbnailFromMemory, gflLoadThumbnailFromHandle
'''See also'''
:[[#gflGetFileInformation|gflGetFileInformation]], [[#gflGetFileInformationFromMemory|gflGetFileInformationFromMemory]]


 
== gflFreeFileInformation ==
gflFreeFileInformation


The gflFreeFileInformation function frees the content of a GFL_FILE_INFORMATION structure.  
The gflFreeFileInformation function frees the content of a GFL_FILE_INFORMATION structure.  


void <b>gflFreeFileInformation</b>(
  GFL_FILE_INFORMATION* information
);


void gflFreeFileInformation(
'''Parameters'''
  GFL_FILE_INFORMATION * information
);
 
Parameters  


bitmap
:information
Pointer to a GFL_FILE_INFORMATION structure.  
::Pointer to a [[Structures#GFL_FILE_INFORMATION|GFL_FILE_INFORMATION]] structure.  


See also  
'''See also'''
:[[#gflLoadBitmap|gflLoadBitmap]], [[#gflLoadBitmapFromMemory|gflLoadBitmapFromMemory]], [[#gflLoadBitmapFromHandle|gflLoadBitmapFromHandle]], [[#gflGetFileInformation|gflGetFileInformation]], [[#gflGetFileInformationFromHandle|gflGetFileInformationFromHandle]], [[#gflGetFileInformationFromMemory|gflGetFileInformationFromMemory]]


gflGetFileInformation, gflLoadBitmap, gflLoadBitmapFromHandle, gflLoadThumbnail, gflLoadThumbnailFromHandle
[[Category: GFLSDK Reference Manual]]

Latest revision as of 19:19, 27 April 2010

gflGetDefaultLoadParams

The gflGetDefaultLoadParams function sets the GFL_LOAD_PARAMS structure with default values. Must be called before gflLoadBitmap*. 

void gflGetDefaultLoadParams(
  GFL_LOAD_PARAMS* load_params
);

Parameters

load_params
Pointer to a GFL_LOAD_PARAMS structure.

See also

gflGetDefaultThumbnailParams, gflLoadBitmap, gflLoadBitmapFromHandle, gflLoadBitmapFromMemory


gflLoadBitmap

The gflLoadBitmap function loads a picture file into memory. 

GFL_ERROR gflLoadBitmap(
  const char* filename,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION * informations
);

Parameters

filename
Pointer to a null-terminated string that contains the filename to load.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

Remark

gflLoadBitmapW exists for the windows unicode version of GFLSDK

See also

gflGetDefaultLoadParams, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle

gflLoadBitmapFromMemory

The gflLoadBitmapFromMemory function loads a picture from memory. 

GFL_ERROR gflLoadBitmapFromMemory(
  const GFL_UINT8* data,  
  GFL_UINT32 data_length,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

data
Pointer to the picture.
data_length
Length of data.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflGetDefaultLoadParams, gflLoadBitmap, gflLoadBitmapFromHandle

gflLoadBitmapFromHandle

The gflLoadBitmapFromHandle function loads a picture into memory with the use of read callback functions. 

GFL_ERROR gflLoadBitmapFromHandle(
  GFL_HANDLE handle,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

handle
User handle. The Callbacks field of the GFL_LOAD_PARAMS structure must be filled correctly.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflGetDefaultLoadParams, gflLoadBitmap, gflLoadBitmapFromMemory

gflGetDefaultThumbnailParams

The gflGetDefaultThumbnailParams function sets the GFL_LOAD_PARAMS structure with default values. Must be called before gflGetDefaultThumbnail*. 

void gflGetDefaultThumbnailParams(
  GFL_LOAD_PARAMS* load_params
);

Parameters

load_params
Pointer to a GFL_LOAD_PARAMS structure.

See also

gflGetDefaultLoadParams, gflLoadThumbnail, gflLoadThumbnailFromHandle, gflLoadThumbnailFromMemory


gflLoadThumbnail

The gflLoadThumbnail function loads a picture file as a thumbnail into memory. 

GFL_ERROR gflLoadThumbnail(
  const char* filename,  
  GFL_INT32 width,  
  GFL_INT32 height,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

filename
Pointer to a null-terminated string that contains the filename to load.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

Remark

gflLoadThumbnailW exists for the windows unicode version of GFLSDK

See also

gflGetDefaultThumbnailParams, gflLoadThumbnailFromHandle, gflLoadThumbnailFromMemory

gflLoadThumbnailFromMemory

The gflLoadThumbnailFromMemory function loads a picture file as a thumbnail from memory. 

GFL_ERROR gflLoadThumbnailFromMemory(
  const GFL_UINT8* data,  
  GFL_UINT32 data_length,  
  GFL_INT32 width,  
  GFL_INT32 height,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

data
Pointer to the picture.
data_length
Length of data.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflGetDefaultThumbnailParams, gflLoadThumbnail, gflLoadThumbnailFromHandle

gflLoadThumbnailFromHandle

The gflLoadThumbnailFromHandle function loads a picture file as a thumbnail into memory with the use of read callback functions. 

GFL_ERROR gflLoadThumbnailFromHandle(
  GFL_HANDLE handle,  
  GFL_INT32 width,  
  GFL_INT32 height,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

handle
User handle. The Callbacks field of the GFL_LOAD_PARAMS structure must be filled correctly.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflGetDefaultThumbnailParams, gflLoadThumbnail, gflLoadThumbnailFromMemory

gflGetFileInformation

The gflGetFileInformation function retrieves all informations about a picture file. 

GFL_ERROR gflGetFileInformation(
  const char* filename,  
  GFL_INT32 index,  
  GFL_FILE_INFORMATION* information
);

Parameters

filename
Pointer to a null-terminated string that contains the filename.
index
Index of format. -1 for automatic recognition.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

Remark

gflGetFileInformationW exists for the windows unicode version of GFLSDK

See also

gflGetFileInformationFromMemory, gflGetFileInformationFromHandle

gflGetFileInformationFromMemory

The gflGetFileInformationFromMemory function retrieves all informations about a picture from memory. 

GFL_ERROR gflGetFileInformationFromMemory(
  const GFL_UINT8* data,  
  GFL_UINT32 data_length,  
  GFL_INT32 index,  
  GFL_FILE_INFORMATION* information
);

Parameters

data
Pointer to the picture.
data_length
Length of data.
index
Index of format. -1 for automatic recognition.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflGetFileInformation, gflGetFileInformationFromHandle

gflGetFileInformationFromHandle

The gflGetFileInformationFromHandle function retrieves all informations about a picture with the use of read callback functions. 

GFL_ERROR gflGetFileInformationFromHandle(
  GFL_HANDLE handle,  
  GFL_INT32 index,  
  const GFL_LOAD_CALLBACKS* callbacks,  
  GFL_FILE_INFORMATION* information
);

Parameters

handle
User handle.
index
Index of format. -1 for automatic recognition.
callbacks
Pointer to a GFL_LOAD_CALLBACKS to access picture data.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflGetFileInformation, gflGetFileInformationFromMemory

gflFreeFileInformation

The gflFreeFileInformation function frees the content of a GFL_FILE_INFORMATION structure. 

void gflFreeFileInformation(
  GFL_FILE_INFORMATION* information
);

Parameters

information
Pointer to a GFL_FILE_INFORMATION structure.

See also

gflLoadBitmap, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle, gflGetFileInformation, gflGetFileInformationFromHandle, gflGetFileInformationFromMemory
Retrieved from "https://www.xnview.com/wiki/index.php?title=Read&oldid=378"