GetNumThreads
GetNumThreads
Returns the number of existing threads in the multithreading environment.
Syntax
Case 1: Getting number of threads for operations on objects of 32-bit size
IppStatus ippGetNumThreads(int*
pNumThr
);
Case 2: Getting number of threads for operations with TL functions based on the Platform Aware API
IppStatus ippGetNumThreads_LT(int*
pNumThr
);
Case 3: Getting number of threads for operations with TL functions based on the Classic API
IppStatus ippGetNumThreads_T(int*
pNumThr
);
Include Files
ippcore.h
ippcore_tl.h
Parameters
- pNumThr
- Pointer to the number of threads.
Description
This function returns the number of OpenMP* threads specified by the user previously. If it is not specified, the function returns the initial number of threads that depends on the number of logical processors. Functions are not thread-safe, first call shall be outside of the parallel region of the program.
Return Values
- ippStsNoErr
- Indicates no error.
- ippStsNullPtrErr
- Indicates an error condition when thepNumThrpointer isNULL.
- ippStsNoOperation
- Indicates that the function is called from the application linked to the single-threaded version of the library. No operation is performed and return value is always == 1.