file.h
Go to the documentation of this file.
1 /*!**********************************************************************
2 *
3 * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
4 * All rights reserved.
5 *
6 *************************************************************************
7 *
8 * @file file.h
9 * @date Sep 26, 2016
10 * @brief File module header file.
11 *
12 * Meta and payload parts of file type are initialized and filled in this module.
13 *
14 ************************************************************************/
15 
16 #ifndef FILE_H_
17 #define FILE_H_
18 
19 #include "data_types.h"
20 
24 typedef struct mcl_file_t
25 {
28  void *descriptor;
29 } file_t;
30 
48 E_MCL_ERROR_CODE file_initialize(const char *version, const char *file_path, const char *file_name, const char *file_type, const char *routing, file_t **file);
49 
55 void file_destroy(file_t **file);
56 
57 #endif //FILE_H_
E_MCL_ERROR_CODE file_initialize(const char *version, const char *file_path, const char *file_name, const char *file_type, const char *routing, file_t **file)
Definition: file.c:22
item_meta_t meta
Meta of file.
Definition: file.h:26
This struct is used for building file.payload structure.
Definition: data_types.h:151
E_MCL_ERROR_CODE
MCL Error code definitions. Every function returning an error code uses this enum values...
Definition: mcl_common.h:137
This struct is used for building item.meta structure.
Definition: data_types.h:84
This struct is used for building the complete message of file.
Definition: file.h:24
void file_destroy(file_t **file)
Definition: file.c:163
void * descriptor
Descriptor of file.
Definition: file.h:28
file_payload_t payload
Payload of file.
Definition: file.h:27
struct mcl_file_t mcl_file_t
This struct is used for building the complete message of file.
Definition: mcl_store.h:39
Data types module header file.