3.3.12 PDS_UnRegFile

Definition: This function un-registers a file to the PDS. This makes the data stored in the NVM invalid and any operation on this file ID will be invalid after this point.

Syntax

PdsStatus_t PDS_UnRegFile(PdsFileItemIdx_t argFileId);

Input Parameters

Table 3-29. Input Parameter

Parameter Name

Parameter Type

Description

argFileId

PdsFileItemIdx_t

PDS file ID of the item

Return Type and Values

Table 3-30. Return Type

Parameter Name

Parameter Type

Description

PdsStatus_t

ENUM

PDS status codes. Definition available in pds_interface.h.

Table 3-31. 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