WireWare native: WireWare GetMachineClientCount I

From FactorityWiki

Jump to: navigation, search

Contents

Summary

Returns the number of clients, which are attached to this machine object.


WIREWARE_RESULT WireWare_GetMachineClientCount_I (
WIREWARE_MACHINEI_HANDLE handle, // Handle for machine
PWIREWARE_INT count, // Pointer to memory location for client count
WIREWARE_TIMEOUT timeout, // timeout in ms
);

Parameters

handle
Specifies the handle of the machine.
count
Points to a memory location, to which the number of the currently attached clients is copied.
timeout
Specifies the maximum allowed execution time (in ms) for this function.

Result

If the function succeeds, the return value is WIREWARE_ERROR_NONE. Otherwise it returns an appropriate error code.


Explanation

This function returns the number of machines, which are attached to this machine object currently.

See also

WireWare_CreateMachine_I