INtime SDK Help
hpeGetTransmitterState
INtime SDK v7.2 > About INtime > Networking and I/O > High-Performance Ethernet > hpeGetTransmitterState

The call is an alias for hpeGetTransmitQueueState with the queue_index parameter set to 0.

HPESTATUS hpeGetTransmitterState(
    HPEHANDLE devhandle, 
    DWORD *txstate_p
);

Parameters

devhandle
A handle value for the device.
txstate_p
A pointer to a DWORD value to receive the transmitter state. This value may be:
HPE_TXIDLE The transmitter is currently idle.
HPE_TXBUSY The transmitter is performing an operation.

Return Values

A status value indicating the success or failure of the operation:

E_OK The operation completed successfully.
E_EXIST The handle given is not a handle for an open HPE interface.

Notes

If used in conjunction with hpeWaitForTransmitComplete or hpeWaitForTransmitQueueComplete, care must be taken to not leave completion state outstanding on the queue. This may be accomplished by draining the queue with a timeout of 0.

Requirements

Versions Defined in Include Link to
INtime 4.0 intime/rt/include/hpeif2.h hpeif2.h hpeif2.lib
See Also