RTI Connext DDS Micro  Version 2.4.11
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
osapi_process.h
Go to the documentation of this file.
1 /*
2  * FILE: osapi_process.h - Process interface definition
3  *
4  * (c) Copyright, Real-Time Innovations, 2012-2015
5  *
6  * All rights reserved.
7  *
8  * No duplications, whole or partial, manual or electronic, may be made
9  * without express written permission. Any such copies, or
10  * revisions thereof, must display this notice unaltered.
11  * This code contains trade secrets of Real-Time Innovations, Inc.
12  *
13  * Modification History
14  * --------------------
15  * 24mar2012,tk Written
16  */
17 /*ce
18  * \file
19  * \brief Process interface definition
20  */
21 #ifndef osapi_process_h
22 #define osapi_process_h
23 
24 #ifndef osapi_dll_h
25 #include "osapi/osapi_dll.h"
26 #endif
27 #ifndef osapi_types_h
28 #include "osapi/osapi_types.h"
29 #endif
30 
31 #ifdef __cplusplus
32 extern "C"
33 {
34 #endif
35 
36 /*e \file
37  \brief process related utility
38 */
39 
40 /*e \ingroup OSAPI_ProcessClass
41  * \brief Return the process ID, which is unique for the application.
42  *
43  * \details
44  * Return the process ID.
45  *
46  * \return Process id
47 */
48 OSAPIDllExport OSAPI_ProcessId
50 
51 /*ci
52  * \brief Convert a process ID to a string in decimal format
53  * *
54  * \param[inout] buffer Buffer to store result in
55  * \param[in] max_length Maximum length of the buffer
56  * \param[in] pid Process ID to convert
57  *
58  * \return The number of characters placed in the buffer excluding the
59  * NULL termination. If there is insufficient space max_length
60  * is returned.
61  */
62 OSAPIDllExport RTI_INT32
63 OSAPI_Process_pid_as_string(char *buffer,RTI_INT32 max_length,OSAPI_ProcessId pid);
64 
65 #ifdef __cplusplus
66 } /* extern "C" */
67 #endif
68 
69 
70 #endif /* osapi_process_h */

RTI Connext DDS Micro Version 2.4.11 Copyright © Mon Jul 23 2018 Real-Time Innovations, Inc