HccnRpingGetPayload
Applicability
Product |
Supported |
|---|---|
Atlas 350 Accelerator Card |
√ |
√ |
|
√ |
|
☓ |
|
☓ |
|
☓ |
Description
Obtains the custom payload of the target ping packet.
Prototype
1 | HccnResult HccnRpingGetPayload(HccnRpingCtx rpingCtx, void **payload, uint32_t *payloadLen) |
Parameters
Parameter |
Input/Output |
Description |
|---|---|---|
rpingCtx |
Input |
RPing object returned by the HccnRpingInit API. |
payload |
Output |
Pointer to the memory space that stores the custom payload in all packets. |
payloadLen |
Output |
Memory size occupied by the total payloadLen (sum of all payload lengths) obtained. |
Return Value
Parsing result of the error code of the HccnResult type.
Constraints
None
Parent topic: API Reference