WireWare native: WireWare Initialize

From FactorityWiki

Jump to: navigation, search

Contents

Summary

Initializes the WireWare system. It has to be called before any other WireWare function.
Note: This function has been superseded by the function WireWare_InitializeEx.


WIREWARE_RESULTWireWare_Initialize (
WIREWARE_CSTR username // Pointer to username
WIREWARE_CSTR password // Pointer to password
WIREWARE_TIMEOUT timeout // timeout in ms
);

Parameters

username
Points to a null-terminated string. It specifies a username for access control checking.
Note: Since there is no access control implemented in this release of the WireWare system, the username has to be an empty string.
password
Points to a null-terminated string. It specifies the password for access control checking.
Note: Since there is no access control implemented in this release of the WireWare system, the password has to be an empty string.
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 initializes the WireWare subsystem. It has to be called before any other WireWare function.
The function launches the WireWare-Agent, if needed.

See also

WireWare_InitializeEx, WireWare_Shutdown