Zen API | Contents | Reference | Previous | Up | Next

zReceiver_Receive
zReceiver functions
C

    zStatus zReceiver_Receive(zReceiver receiver, z64u timeout, zResult* result);

Parameters

Parameters | Description
zReceiver receiver | zReceiver object.
z64u timeout | Timeout period, in microseconds.

Returns

Receives result object, upon success. Call zResult_Destroy to free the object.

Description

Waits until a zResult object is received, or until the specified timeout period elapses.

Remarks

This function is an alternative to registering for asynchonous result callbacks. This function will fail if a callback handler was registered with the zReceiver_SetReceiveHandler function.

The timeout supplied to this function may not be strictly honored for active mode connections during an interval in which the remote data provider is re-establishing the connection. Under such conditions, the real timeout might vary from 0 to 2*timeout.

This function can only be called after calling zReceiver_Open.

File

zReceiver.h

Copyright (c) 2008-2010 by LMI Technologies Inc. All rights reserved.
Contents | Reference