file.h File Reference

File module header file. More...

#include "item.h"
#include "mcl_core/mcl_time_util.h"

Include dependency graph for file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	file_payload_t
struct	file_t

Functions
MCL_LOCAL mcl_error_t	file_validate (file_t *file)

Variables
const char *	mcl_file_versions []

Detailed Description

File module header file.

Copyright

Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file file.h.

Function Documentation

MCL_LOCAL mcl_error_t file_validate

(

file_t *

file

)

This function checks whether all mandatory parameters of a file are set or not.

Parameters

[in]

file

File to validate.

Returns

• MCL_OK in case of success.
• MCL_INVALID_PARAMETER in case file has one or more missing mandatory parameters.
• MCL_NO_FILE_SUPPORT in case there is no file system.

Definition at line 121 of file file.c.

References file_payload_t::local_path, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_NO_FILE_SUPPORT, MCL_NULL, MCL_OK, file_t::payload, and file_payload_t::remote_name.

Referenced by _store_add_data(), and connectivity_processor_exchange().

Here is the caller graph for this function:

Variable Documentation

const char* mcl_file_versions[]

Definition at line 15 of file file.c.

Referenced by _add_item_meta_payload(), and _item_meta_size().