PDI 1.3.1

the PDI data interface

Initialization and finalization

The initialization and finalization part of the API is used to setup PDI, release its resources and check version information. More...

Functions

PDI_status_t PDI_init (PC_tree_t conf)
 Initializes PDI. More...
 
PDI_status_t PDI_finalize (void)
 Finalizes PDI. More...
 
PDI_status_t PDI_version (unsigned long *provided, unsigned long expected)
 Checks PDI API version. More...
 

Detailed Description

The initialization and finalization part of the API is used to setup PDI, release its resources and check version information.

Function Documentation

◆ PDI_init()

PDI_status_t PDI_init ( PC_tree_t  conf)

Initializes PDI.

Parameters
[in]confthe configuration
Returns
an error status

◆ PDI_finalize()

PDI_status_t PDI_finalize ( void  )

Finalizes PDI.

Returns
an error status

◆ PDI_version()

PDI_status_t PDI_version ( unsigned long *  provided,
unsigned long  expected 
)

Checks PDI API version.

Parameters
[out]providedversion if non-null it is filled with the provided API version
[in]expectedif non-zero the expected API version
Returns
an error status if the expected version is incompatible with the provided one