fpFreeImageInfos()

This function frees the memory associated with an image info context. Call this function when you have finished using the image info context for calls to fpGetOutputImageCount() and fpGetOutputImageInfo() (see fpGetOutputImageCount() and fpGetOutputImageInfo()).

Syntax

BOOL pascal fpFreeImageInfos (
      void* const pContext,
      void* const pImageInfos)

Arguments

pContext A pointer to a KeyView Export session that you initialized by calling fpInit(), and the pointer originally passed to fpGetOutputImageInfos() to create the image info context that you want to free.
pImageInfos A pointer returned from fpGetOutputImageInfos(). See fpGetOutputImageInfos().

Returns

  • If the call is successful, the return value is TRUE.

  • If the call is unsuccessful, the return value is FALSE.

Discussion

  • It is safe to call fpFreeImageInfos() with pImageInfos() set to NULL. The function returns TRUE in this case.
  • You must call fpFreeImageInfos() before you call fpShutdown() (see fpShutDown()).
  • You must not call fpGetOutputImageCount(), fpGetOutputImageInfo(), and fpFreeImageInfos() using an image info context pointer for which the associated system resources have already been successfully freed by using fpFreeImageInfos().