Actions

Difference between revisions of "Initialisation"

From XnView Wiki

Line 4: Line 4:


  GFL_ERROR <b>gflLibraryInit</b>(
  GFL_ERROR <b>gflLibraryInit</b>(
&nbsp;&nbsp;void
  void
  );
  );


Line 21: Line 21:


  GFL_ERROR <b>gflLibraryInitEx</b>(
  GFL_ERROR <b>gflLibraryInitEx</b>(
&nbsp;&nbsp;GFL_ALLOC_CALLBACK alloc_callback,   
  GFL_ALLOC_CALLBACK alloc_callback,   
&nbsp;&nbsp;GFL_REALLOC_CALLBACK realloc_callback,   
  GFL_REALLOC_CALLBACK realloc_callback,   
&nbsp;&nbsp;GFL_FREE_CALLBACK free_callback,   
  GFL_FREE_CALLBACK free_callback,   
&nbsp;&nbsp;void * user_parms
  void * user_parms
  );
  );


Line 52: Line 52:


  void <b>gflLibraryExit</b>(
  void <b>gflLibraryExit</b>(
&nbsp;&nbsp;void
  void
  );
  );


Line 65: Line 65:


  const char* <b>gflGetVersion</b>(
  const char* <b>gflGetVersion</b>(
&nbsp;void
  void
  );
  );


Line 78: Line 78:


  void <b>gflSetPluginsPathname</b>(
  void <b>gflSetPluginsPathname</b>(
&nbsp;const char* pathname
  const char* pathname
  );
);


'''Parameters'''
'''Parameters'''

Revision as of 13:09, 23 September 2009

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 read user function. (void (GFLAPI *)( void * ptr, void * user_parms ))
user_parms
User parameter 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