Initialisation

From XnView Wiki
Jump to: navigation, search

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