PROFINET Device4.2.0
 
Loading...
Searching...
No Matches

◆ PN_API_IOD_setIops()

uint32_t PN_API_IOD_setIops ( PN_API_IOD_Handle_t *const  pnHandle,
const uint32_t  api,
const uint32_t  slotNum,
const uint32_t  subNum,
const PN_API_IOD_IOXS  iops 
)

Changes the IOPS value of submodules, that have no IO data. For example: PDev.

Parameters
[in]pnHandleProfinet API Handle
[in]apiApplication Process Identifier.
[in]slotNumSlot number, can not be 0.
[in]subNumSubslot number, which can be:
0: setIops for all submodules.
not 0: setIops for the specific module.
[in]iopsPN_API_IOD_STATUS_BAD or PN_API_IOD_STATUS_GOOD.
Returns
result of the operation as uint32_t.
Return values
PN_API_OKSuccess.
PN_API_NOT_OKSomething went wrong.
PN_API_ERR_PARAMInvalid parameter.
Example
#include "pn_api_iod_data.h"
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status, api = 0, slotNum = 0, subNum = 0;
pnHandle = PN_API_IOD_new();
status = PN_API_IOD_setIops(pnHandle, api, slotnum, subnum, iops);
uint32_t PN_API_IOD_setIops(PN_API_IOD_Handle_t *const pnHandle, const uint32_t api, const uint32_t slotNum, const uint32_t subNum, const PN_API_IOD_IOXS iops)
Changes the IOPS value of submodules, that have no IO data. For example: PDev.
#define PN_API_IOD_STATUS_GOOD
IO provider or consumer status is "good".
Definition pn_api_iod_data.h:29
PN_API_IOD_Handle_t * PN_API_IOD_new(void)
Creates Profinet API handle.
#define PN_API_IOD_IOXS
IO provider/consumer status.
Definition pn_api_iod_types.h:44
struct PN_API_IOD_Handle PN_API_IOD_Handle_t
API handle instance which holds IO device's info.
Definition pn_api_iod_types.h:61