L_SetTempDirectory

#include "l_bitmap.h"

L_LTKRN_API L_INT L_SetTempDirectory(pszTempDir)

Sets the directory in which LEADTOOLS will create temporary files.

Parameters

L_TCHAR* pszTempDir

Character string that contains the temporary directory name. This should be a valid directory name and the directory should exist. It cannot be NULL.

Comments

Files used to store bitmaps of type TYPE_DISK will be created here. Also, disk tiles for TYPE_TILED bitmaps will be created here.

This function will have no effect on any existing bitmaps. The files associated with the existing bitmaps stay where they were. The new temporary directory will be used for creating new bitmaps.

If the image is allocated as TYPE_DISK, then the image should not be used in multiple threads.

Use L_SetTempFileOptions to control whether the temporary files are kept on disk, in memory or a combination of disk and memory. See the TEMPFILEOPTIONS topic for more information.

Required DLLs and Libraries

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

L_INT SetTempDirectoryExample(L_VOID) 
{ 
   L_INT nRet; 
   /* Set the current directory  */ 
   nRet = L_SetTempDirectory(MAKE_IMAGE_PATH(TEXT(""))); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
}
Help Version 20.0.2020.4.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help
Introduction
Version History
Getting Started
Files To Be Included With Your Application
Document Writers – Files To Be Included With Your Application
LEADTOOLS Raster Imaging Features
Quick Reference
Tutorials
Function References
Callback Functions
Summary of Features
Appendix