IPktXPacketX Interface Reference
[PacketX]

PacketX class default interface. More...

List of all members.

Public Member Functions
HRESULT	Start (void)
	Start packet capture.
HRESULT	Stop (void)
	Stop packet capture.
HRESULT	Reset (void)
	Reset network adapters collection .
Properties
IDispatch **	Adapters [get]
	Network adapters.
IDispatch **	Adapter [get]
	Selected network adapter.
BSTR *	Copyright [get]
	Get copyright information.
VARIANT_BOOL *	IsRunning [get]
	Get running state.

---

Detailed Description

PacketX class default interface.

You can use this interface to enumerate currently available network adapters , select target adapter for packet capture and start or stop packet capture session.

---

Member Function Documentation

HRESULT IPktXPacketX::Start

(

void

)

Start packet capture.

Starts packet capture or statistics collection.

Note:

All capture parameters are defined by the default Adapter .

See also:

IPktXPacketX::Adapter to change the selected network adapter.

Returns:

HRESULT error code.

HRESULT IPktXPacketX::Stop

(

void

)

Stop packet capture.

Stops packet capture or statistics collection.

Returns:

HRESULT error code.

HRESULT IPktXPacketX::Reset

(

void

)

Reset network adapters collection .

Use this method to reset the contents of adapters collection to reflect currently available network interfaces.

See also:

IPktXPacketX::Adapters to list currently available network adapters.

Returns:

HRESULT error code.

---

Property Documentation

HRESULT IPktXPacketX::Adapters [get]

Network adapters.

Returns collection of currently available network interfaces.

Returns:

HRESULT error code.

HRESULT IPktXPacketX::Adapter [get]

Selected network adapter.

The default network adapter that will be opened next time you start the PacketX .

Returns:

HRESULT error code.

HRESULT IPktXPacketX::Copyright [get]

Get copyright information.

Returns short copyright text.

Returns:

HRESULT error code.

HRESULT IPktXPacketX::IsRunning [get]

Get running state.

Returns current packet capture state.

Returns:

HRESULT error code.

---

The documentation for this interface was generated from the following file:

• PacketX.idl