Actions

Difference between revisions of "Initialisation"

From XnView Wiki

(Created page with '<div style="float:right">__TOC__</div> == gflLibraryInit == The gflLibraryInit function initialize the library. Must be used before call of GFL's functions. <blockquote style…')
 
m (Reverted edits by Akajavim (Talk) to last revision by WikiSysop)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<div style="float:right">__TOC__</div>
== gflLibraryInit ==
== gflLibraryInit ==


The gflLibraryInit function initialize the library. Must be used before call of GFL's functions.  
The gflLibraryInit function initialize the library. Must be used before call of GFL's functions.  


<blockquote style="background-color:#f0f0f0;">
GFL_ERROR <b>gflLibraryInit</b>(
GFL_ERROR gflLibraryInit(
  void
  void
);
);
</blockquote>


'''Return value'''  
'''Return value'''  


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


'''See also'''  
'''See also'''  


:gflLibraryInitEx, gflLibraryExit, gflEnableLZW, gflGetVersion, gflGetErrorString
:[[#gflLibraryExit|gflLibraryExit]], [[#gflSetPluginsPathname|gflSetPluginsPathname]], [[Error|gflGetErrorString]]




Line 24: Line 20:
The gflLibraryInitEx function initialize the library. Must be used before call of GFL's functions.  
The gflLibraryInitEx function initialize the library. Must be used before call of GFL's functions.  


<blockquote style="background-color:#f0f0f0;">
GFL_ERROR <b>gflLibraryInitEx</b>(
GFL_ERROR gflLibraryInitEx(
  GFL_ALLOC_CALLBACK alloc_callback,   
  GFL_ALLOC_CALLBACK alloc_callback,   
  GFL_REALLOC_CALLBACK realloc_callback,   
  GFL_REALLOC_CALLBACK realloc_callback,   
  GFL_FREE_CALLBACK free_callback,   
  GFL_FREE_CALLBACK free_callback,   
  void * user_parms
  void * user_parms
);
);
</blockquote>


'''Parameters'''  
'''Parameters'''  
Line 40: Line 34:
::Pointer to a read user function. (void * (GFLAPI *)( void * ptr, GFL_UINT32 new_size, void * user_parms ))  
::Pointer to a read user function. (void * (GFLAPI *)( void * ptr, GFL_UINT32 new_size, void * user_parms ))  
:free_callback  
:free_callback  
::Pointer to a read user function. (void (GFLAPI *)( void * ptr, void * user_parms ))  
::Pointer to a free user function. (void (GFLAPI *)( void * ptr, void * user_parms ))  
:user_parms  
:user_parms  
::User parameter used in callback.  
::User parameters used in callback.  


'''Return value'''  
'''Return value'''  


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


'''See also'''  
'''See also'''  


:gflLibraryInit, gflLibraryExit, gflEnableLZW, gflGetVersion, gflGetErrorString
:[[#gflLibraryExit|gflLibraryExit]], [[#gflSetPluginsPathname|gflSetPluginsPathname]], [[Error|gflGetErrorString]]
 


== gflLibraryExit ==
== gflLibraryExit ==
Line 57: Line 50:
The gflLibraryExit function frees the library.  
The gflLibraryExit function frees the library.  


<blockquote style="background-color:#f0f0f0;">
void <b>gflLibraryExit</b>(
void gflLibraryExit(
  void
  void
);
);
 
</blockquote>
'''See also'''
 
:[[#gflLibraryInit|gflLibraryInit]], [[Error|gflGetErrorString]]
 
 
== gflGetVersion ==
 
The gflGetVersion function returns the GFL's version.
 
const char* <b>gflGetVersion</b>(
  void
);
 
'''Return value'''
 
:Pointer to a null-terminated string that contains version of GFL.
 
 
== gflSetPluginsPathname ==
 
The gflSetPluginsPathname function allows to set a Plugin's folder. Be careful, this function must be called before gflLibraryInit.
 
void <b>gflSetPluginsPathname</b>(
  const char* pathname
);
 
'''Parameters'''
 
:pathname
::Pointer to a null-terminated string that contains the pathname of plugins.


'''See also'''  
'''See also'''  
:[[#gflLibraryInit|gflLibraryInit]], [[#gflLibraryExit|gflLibraryExit]]
'''Remark'''
:gflSetPluginsPathnameW exists for the windows unicode version of GFLSDK


:gflLibraryInit, gflLibraryInitEx, gflEnableLZW, gflGetVersion
[[Category: GFLSDK Reference Manual]]

Latest revision as of 15:25, 22 November 2010

gflLibraryInit

The gflLibraryInit function initialize the library. Must be used before call of GFL's functions. 

GFL_ERROR gflLibraryInit(
  void
);

Return value

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

See also

gflLibraryExit, gflSetPluginsPathname, gflGetErrorString


gflLibraryInitEx

The gflLibraryInitEx function initialize the library. Must be used before call of GFL's functions. 

GFL_ERROR gflLibraryInitEx(
  GFL_ALLOC_CALLBACK alloc_callback,  
  GFL_REALLOC_CALLBACK realloc_callback,  
  GFL_FREE_CALLBACK free_callback,  
  void * user_parms
);

Parameters

alloc_callback
Pointer to an alloc user function. (void * (GFLAPI *)( GFL_UINT32 size, void * user_parms ))
realloc_callback
Pointer to a read user function. (void * (GFLAPI *)( void * ptr, GFL_UINT32 new_size, void * user_parms ))
free_callback
Pointer to a free user function. (void (GFLAPI *)( void * ptr, void * user_parms ))
user_parms
User parameters used in callback.

Return value

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

See also

gflLibraryExit, gflSetPluginsPathname, gflGetErrorString

gflLibraryExit

The gflLibraryExit function frees the library. 

void gflLibraryExit(
  void
);

See also

gflLibraryInit, gflGetErrorString


gflGetVersion

The gflGetVersion function returns the GFL's version. 

const char* gflGetVersion(
  void
);

Return value

Pointer to a null-terminated string that contains version of GFL.


gflSetPluginsPathname

The gflSetPluginsPathname function allows to set a Plugin's folder. Be careful, this function must be called before gflLibraryInit. 

void gflSetPluginsPathname(
  const char* pathname
);

Parameters

pathname
Pointer to a null-terminated string that contains the pathname of plugins.

See also

gflLibraryInit, gflLibraryExit

Remark

gflSetPluginsPathnameW exists for the windows unicode version of GFLSDK
Retrieved from "https://www.xnview.com/wiki/index.php?title=Initialisation&oldid=555"