View source for Write

== gflGetDefaultSaveParams ==

The gflGetDefaultSaveParams function sets the [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure with default values. To use before call of gflSaveBitmap. 

 void <b>gflGetDefaultSaveParams</b>(
   GFL_SAVE_PARAMS* save_params
 );

'''Parameters'''

:save_params 
::Pointer to a [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure. 

'''See also'''
:[[#gflSaveBitmap|gflSaveBitmap]], [[#gflSaveBitmapIntoHandle|gflSaveBitmapIntoHandle]], [[#gflSaveBitmapIntoMemory|gflSaveBitmapIntoMemory]]


== gflSaveBitmap ==

The gflSaveBitmap function save a picture in memory into a file. 

 GFL_ERROR <b>gflSaveBitmap</b>(
   char* filename,  
   const GFL_BITMAP* bitmap,  
   const GFL_SAVE_PARAMS* params,  
 );

'''Parameters'''

:filename 
::Pointer to a null-terminated string that contains the filename to save. 
:bitmap 
::Pointer to a [[#GFL_BITMAP|GFL_BITMAP]] structure. 
:params 
::Pointer to a [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure. 
::This structure must be filled correctly, in particular the FormatIndex field. 

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

'''See also'''
:[[#gflGetDefaultSaveParams|gflGetDefaultSaveParams]], [[#gflSaveBitmapIntoMemory|gflSaveBitmapIntoMemory]], [[#gflSaveBitmapIntoHandle|gflSaveBitmapIntoHandle]]

== gflSaveBitmapIntoMemory ==

The gflSaveBitmapIntoMemory function save a picture in memory into a file with the use of write callback functions. 

 GFL_ERROR <b>gflSaveBitmapIntoMemory</b>(
   GFL_UINT8** data, 
   GFL_UINT32* data_length, 
   const GFL_BITMAP* bitmap,  
   const GFL_SAVE_PARAMS* params,  
 );

'''Parameters'''

:data
::Address of a pointer for allocated data
:data_length
::Pointer for the final length of data
:bitmap 
::Address of a pointer to a [[#GFL_BITMAP|GFL_BITMAP]] structure. 
:params 
::Pointer to a [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure. 
::This structure must be filled correctly, in particular the FormatIndex field. 

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

'''See also'''
:[[#gflGetDefaultSaveParams|gflGetDefaultSaveParams]], [[#gflSaveBitmap|gflSaveBitmap]], [[#gflSaveBitmapIntoHandle|gflSaveBitmapIntoHandle]]

== gflSaveBitmapIntoHandle ==

The gflSaveBitmapIntoHandle function save a picture in memory into a file with the use of write callback functions. 

 GFL_ERROR <b>gflSaveBitmapIntoHandle</b>(
   GFL_HANDLE handle,  
   const GFL_BITMAP* bitmap,  
   const GFL_SAVE_PARAMS* params,  
 );

'''Parameters'''

:handle 
::User handle. The Callbacks field of the [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure must be filled correctly. 
:bitmap 
::Address of a pointer to a [[#GFL_BITMAP|GFL_BITMAP]] structure. 
:params 
::Pointer to a [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure. 
::This structure must be filled correctly, in particular the FormatIndex field. 

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

'''See also'''
:[[#gflGetDefaultSaveParams|gflGetDefaultSaveParams]], [[#gflSaveBitmap|gflSaveBitmap]], [[#gflSaveBitmapIntoMemory|gflSaveBitmapIntoMemory]]

== gflFileCreate ==

The gflFileCreate function creates a multi-page file. 

 GFL_ERROR <b>gflFileCreate</b>(
   GFL_FILE_HANDLE* handle,  
   const char* filename,  
   GFL_UINT32 image_count,  
   GFL_SAVE_PARAMS* params
 );

'''Parameters'''

:handle 
::Address of an handle. 
:filename 
::Pointer to a null-terminated string that contains the filename to create. 
:image_count 
::Number of picture to be added. 
:params 
::Pointer to a [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure. 
::This structure must be filled correctly. 

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

'''See also'''
:[[#gflFileAddPicture|gflFileAddPicture]], [[#gflFileClose |gflFileClose ]]


== gflFileAddPicture ==

The gflFileAddPicture function add a picture to a multi-page file. 

 GFL_ERROR <b>gflFileAddPicture(</b>
   GFL_FILE_HANDLE  handle,  
   const GFL_BITMAP* bitmap
 );

'''Parameters'''

:handle 
::Handle of the file. 
:bitmap 
::Pointer to a [[#GFL_BITMAP|GFL_BITMAP]] structure. This is the picture to add. 

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

'''See also''' 
:[[#gflFileCreate|gflFileCreate]], [[#gflFileClose |gflFileClose ]]


== gflFileClose ==

The gflFileClose function closes a multi-page file. 

 void <b>gflFileClose</b>(
   GFL_FILE_HANDLE handle
 );

'''Parameters'''

:handle 
::Handle of file. 

'''See also'''
:[[#gflFileCreate|gflFileCreate]], [[#gflFileAddPicture|gflFileAddPicture]]