Requesting Information

Get Status


Retrieve a status report for a connection.

#include "laygo.h"

LResult lgo_GetStatus
        LCid           cid,
        LCtlBuffer     buffer,
        LBufferSize    size
cidconnection to retrieve status report on
bufferbuffer to hold retrieved status report
sizesize of buffer

lgo_GetStatus() retrieves the status report for a connection. If the call to lgo_GetStatus() is successful, the contents of the control buffer passed to the function may be cast to type LStatusReport as defined in laygodef.h.

Return Values

If successful, lgo_GetStatus() returns a non-negative value indicating the number of bytes returned into the buffer. A return value of 0 means that no status report for the connection is available. Otherwise, it returns a negative value indicating the reason it failed. Possible unsuccessful return values are:

See Also


lgo_GetStatus(cid, buffer, bufCapacity);