L_GetTempFileOptions (original) (raw)
Summary
Gets the temp file options used by LEADTOOLS. These options can be used to indicate whether the temporary files will be created on disk, in memory or a combination of disk and memory.
Syntax
#include "l_bitmap.h"
L_LTKRN_API L_INT L_GetTempFileOptions(pTempFileOptions, uStructSize)
Parameters
TEMPFILEOPTIONS * pTempFileOptions
Pointer to a structure to be updated with the temp file options.
L_UINT uStructSize
Size of the structure pointed to by pTempFileOptions.
Returns
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| ERROR_NULL_PTR | [-814] pTempFileOptions is NULL. |
| ERROR_INVALID_STRUCT_SIZE | [-789] uStructSize is invalid. It should be set to sizeof(TEMPFILEOPTIONS). |
| < 1 | Another error occurred. Refer to Return Codes. |
| ERROR_NULL_PTR | [-814] pTempFileOptions is NULL. |
| ERROR_INVALID_STRUCT_SIZE | [-789] uStructSize is invalid. It should be set to sizeof(TEMPFILEOPTIONS). |
Comments
The options obtained by this function are global. All threads use the same values. For more information on how temp files are used in LEADTOOLS, refer to the TEMPFILEOPTIONS topic.
This feature is available in version 20 or higher.
Required DLLs and Libraries
- LTKRN
- For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.
Platforms
Win32, x64, Linux.
See Also
Functions
Topics
Example
For an example, refer to TEMPFILEOPTIONS
LEADTOOLS Raster Imaging C API Help