EOS_P2P_ClearPacketQueue

EOS API reference page for EOS_P2P_ClearPacketQueue

Choose your implementation method:

C

C#

This function is part of the P2P Interface.

Remarks

Clear queued incoming and outgoing packets.

Return Value

  • EOS_EResult::EOS_Success - if the input options were valid (even if queues were empty and no packets where cleared)

  • EOS_EResult::EOS_IncompatibleVersion - if wrong API version

  • EOS_EResult::EOS_InvalidUser - if wrong local and/or remote user

  • EOS_EResult::EOS_InvalidParameters - if input was invalid in other way

Parameters

EOS_P2P_ClearPacketQueue

Parameter Type And Name

Usage Information

EOS_HP2P Handle

const EOS_P2P_ClearPacketQueueOptions* Options

Information about which queues should be cleared

Related API Members

This function is part of the P2P Interface.

Remarks

Clear queued incoming and outgoing packets. {Result}::{Result.IncompatibleVersion} - if wrong API version {Result}::{Result.InvalidUser} - if wrong local and/or remote user {Result}::{Result.InvalidParameters} - if input was invalid in other way

Return Value

{Result}::{Result.Success} - if the input options were valid (even if queues were empty and no packets where cleared)

Parameters

P2P.P2PInterface.ClearPacketQueue

Parameter Type And Name

Usage Information

ClearPacketQueueOptions options

Information about which queues should be cleared

Related API Members

Tags