3.3.11 PDS_RegFile

Definition: This function registers a file to the PDS.

Syntax

PdsStatus_t PDS_RegFile(PdsFileItemIdx_t argFileId, PdsFileMarks_t argFileMarks);

Input Parameters

Table 3-26. Input Parameters
Parameter Names	Parameter Types	Description
argFileId	PdsFileItemIdx_t	PDS file ID of the item.
argFileMarks	PdsFileMarks_t	This structure contains details about number of items in file, RAM address for each item and size of each item in a list form. This will be stored in PDS and used to retrieve data during PDS operations.

Return Type and Values

Table 3-27. Return Type
Parameter Name	Parameter Type	Description
`PdsStatus_t`	ENUM	PDS status codes. Definition available in `pds_interface.h`.

Table 3-28. Return Values
Return Value	Reason
PDS_OK	PDS operation is success
PDS_INVALID_FILE_IDX	File ID in the argument is not valid one

API Type – Synchronous