WMX3Api Class


Function	C++	static WMX3APIFUNC ErrorToString(int errCode, char *pString, unsigned int size);
	Python	def ErrorToString(errCode)
Returns	Type	string
	Value	error string
Remarks

Function	C++	static WMX3APIFUNC ErrorToString(int errCode, wchar_t *pString, unsigned int size);
	Python
Returns	Type
	Value
Remarks

Function	C++	static WMX3APIFUNC ApiLogToString(unsigned char pLogData, unsigned int logDataSize, char pString, unsigned int size);
	Python	def ApiLogToString(pLogData, logDataSize)
Returns	Type	string
	Value	API log string
Remarks

Function	C++	static WMX3APIFUNC ApiLogToString(unsigned char pLogData, unsigned int logDataSize, wchar_t pString, unsigned int size);
	Python
Returns	Type
	Value
Remarks

Function	C++	static WMX3APIFUNC GetLibVersion(int pMajorVersion, int pMinorVersion, int pRevisionVersion, int pFixVersion);
	Python	def GetLibVersion()
Returns	Type	tuple
	Value	0 : int - error code 1 : int - MajorVersion 2 : int - MinorVersion 3 : int - RevisionVersion 4 : int - FixVersion
Remarks

Function	C++	static WMX3APIFUNC GetIMDllVersion(int pVersion, int pRevision);
	Python	def GetIMDllVersion()
Returns	Type	tuple
	Value	0 : int - error code 1 : int - version 2 : int - revision
Remarks

Function	C++	static WMX3APIFUNC PrintToFile(const char* filePath, const char * format, …);
	Python	def PrintToFile(filePath, format)
Returns	Type	int
	Value	error code
Remarks

Function	C++	static WMX3APIFUNC PrintToFile(const wchar_t* filePath, const wchar_t * format, …);
	Python
Returns	Type
	Value
Remarks

Function	C++	static WMX3APIFUNC PrintToFileIfExist(const char* filePath, const char * format, …);
	Python	def PrintToFileIfExist(filePath, format)
Returns	Type	int
	Value	error code
Remarks

Function	C++	static WMX3APIFUNC PrintToFileIfExist(const wchar_t* filePath, const wchar_t * format, …);
	Python
Returns	Type
	Value
Remarks

Function	C++	static WMX3APIFUNC GetStdOutStr(char* buff, int buffSize, unsigned char* isWideChar, int* strlen);
	Python	def GetStdOutStr()
Returns	Type	string
	Value	WMX3 engine message
Remarks

Function	C++	static WMX3APIFUNC GetStdOutDataSize();
	Python	def GetStdOutDataSize();
Returns	Type	int
	Value	error code
Remarks

Function	C++	static WMX3APIFUNC ClearStdOut();
	Python	def ClearStdOut();
Returns	Type	int
	Value	error code
Remarks

Function	C++	static WMX3APIFUNC ReleaseStdOut();
	Python	def ReleaseStdOut();
Returns	Type	int
	Value	error code
Remarks

Function	C++	bool IsDeviceValid();
	Python	def IsDeviceValid()
Returns	Type	bool
	Value	Whether the device is alive
Remarks

Function	C++	WMX3APIFUNC StartEngine(const char* path, unsigned int waitTimeMilliseconds = 0, int core = -1, DWORD_PTR affinityMask = 0);
	Python	def StartEngine(path) def StartEngine(path, waitTimeMilliseconds) StartEngine(path, waitTimeMilliseconds, core) StartEngine(path, waitTimeMilliseconds, core, affinityMask)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC StartEngine(const wchar_t* path, unsigned int waitTimeMilliseconds = 0, int core = -1, DWORD_PTR affinityMask = 0);
	Python
Returns	Type
	Value
Remarks

Function	C++	WMX3APIFUNC RestartEngine(const char* path, unsigned int waitTimeMilliseconds = 0, int core = -1, DWORD_PTR affinityMask = 0);
	Python	def RestartEngine(path) def RestartEngine(path, waitTimeMilliseconds) RestartEngine(path, waitTimeMilliseconds, core) RestartEngine(path, waitTimeMilliseconds, core, affinityMask)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC RestartEngine(const wchar_t* path, unsigned int waitTimeMilliseconds = 0, int core = -1, DWORD_PTR affinityMask = 0);
	Python
Returns	Type
	Value
Remarks

Function	C++	WMX3APIFUNC StopEngine(unsigned int waitTimeMilliseconds = 0);
	Python	def StopEngine() def StopEngine(waitTimeMilliseconds)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC CreateDevice(const char* path, DeviceType::T type = DeviceType::T::DeviceTypeNormal, unsigned int waitTimeMilliseconds = 0, int core = -1, DWORD_PTR affinityMask = 0);
	Python	def CreateDevice(path) def CreateDevice(path, type) CreateDevice(path, type, waitTimeMilliseconds) CreateDevice(path, type, waitTimeMilliseconds, affinityMask)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC CreateDevice(const wchar_t* path, DeviceType::T type = DeviceType::T::DeviceTypeNormal, unsigned int waitTimeMilliseconds = 0, int core = -1, DWORD_PTR affinityMask = 0);
	Python
Returns	Type
	Value
Remarks

Function	C++	WMX3APIFUNC CloseDevice();
	Python	def CloseDevice()
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC GetDeviceID(int *id);
	Python	def GetDeviceID()
Returns	Type	tuple
	Value	0 : int - error code 1 : int - id
Remarks

Function	C++	WMX3APIFUNC AutoQuitWithoutActiveDev(bool quit);
	Python	def AutoQuitWithoutActiveDev(quit)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC SetWatchdog(unsigned int watchdog);
	Python	def SetWatchdog(watchdog)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC SetWatchdog(int deviceId, unsigned int watchdog);
	Python	def SetWatchdog(deviceId, watchdog)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC GetWatchdog(unsigned int* watchdog, unsigned int* watchdogCount = NULL);
	Python	def GetWatchDog()
Returns	Type	tuple
	Value	0 : int - error code 1 : int - watchdog 2 : int - watchdogCount
Remarks

Function	C++	WMX3APIFUNC ResetWatchdogTimer();
	Python	def ResetWatchdogTimer()
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC SetStatistic(bool enable);
	Python	def SetStatistic(enable)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC GetStatistic(DeviceStatistics* statistics);
	Python	def GetStatistic()
Returns	Type	tuple
	Value	0 : int - error code 1 : DeviceStatistics - statistics
Remarks

Function	C++	WMX3APIFUNC SetInterruptId(unsigned int interruptId);
	Python	def SetInterruptId(interrputId)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC GetInterruptId(unsigned int* interruptId);
	Python	def GetInterruptId(interrputId)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC StartCommunication(unsigned int waitTimeMilliseconds = 0);
	Python	def StartCommunication() def StartCommunication(waitTimeMilliSeconds)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC StopCommunication(unsigned int waitTimeMilliseconds = 0);
	Python	def StopCommunication() def StopCommunication(waitTimeMilliSeconds)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC GetModulesInfo(ModulesInfoA* modules);
	Python	def GetModulesInfo()
Returns	Type	tuple
	Value	0 : int - error code 1 : ModulesInfo - modules
Remarks

Function	C++	WMX3APIFUNC GetModulesInfo(ModulesInfoW* modules);
	Python
Returns	Type
	Value
Remarks

Function	C++	WMX3APIFUNC GetModuleInfo(int moduleId, ModuleInfoA* module);
	Python	def GetModuleInfo(moduleId)
Returns	Type	tuple
	Value	0 : int - error code 1 : ModuleInfo - module
Remarks

Function	C++	WMX3APIFUNC GetModuleInfo(int moduleId, ModuleInfoW* module);
	Python
Returns	Type
	Value
Remarks

Function	C++	WMX3APIFUNC GetEngineStatus(EngineStatus* status);
	Python	def GetEngineStatus()
Returns	Type	tuple
	Value	0 : int - error code 1 : EngineStatus - status
Remarks

Function	C++	WMX3APIFUNC GetAllDevices(DevicesInfoA* devices);
	Python	def GetAllDevices()
Returns	Type	tuple
	Value	0 : int - error code 1 : DevicesInfo - devices
Remarks

Function	C++	WMX3APIFUNC GetAllDevices(DevicesInfoW* devices);
	Python
Returns	Type
	Value
Remarks

Function	C++	WMX3APIFUNC SetDeviceName(const char* name);
	Python	def SetDeviceName(name)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC SetDeviceName(const wchar_t* name);
	Python
Returns	Type
	Value
Remarks

Function	C++	WMX3APIFUNC GetDeviceName(char* nameBuf, unsigned int bufSize);
	Python	def GetDeviceName()
Returns	Type	tuple
	Value	0 : int - error code 1 : str - name
Remarks

Function	C++	WMX3APIFUNC GetDeviceName(wchar_t* nameBuf, unsigned int bufSize);
	Python
Returns	Type
	Value
Remarks

Function	C++	WMX3APIFUNC SetDeviceWaitEvent(int errCode);
	Python	def SetDeviceWaitEvent(errCode);
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC ResetDeviceWaitEvent();
	Python	def ResetDeviceWaitEvent();
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC WaitForDeviceWaitEvent(unsigned int waitTime, int* errCode);
	Python	def WaitForDeviceWaitEvent(waitTime, errCode);
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC SetModuleSuspend(ModuleSuspend* suspend);
	Python	def SetModuleSuspend(suspend)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC GetModuleSuspend(ModuleSuspend* suspend);
	Python	def GetModuleSuspend()
Returns	Type	tuple
	Value	0 : int - error code 1 : ModuleSuspend - suspend
Remarks

Function	C++	WMX3APIFUNC AbortModuleSuspend();
	Python	def AbortModuleSuspend()
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC SleepAtEngine(unsigned long microSecond);
	Python	def SleepAtEngine(microSecond)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC PrintToServerConsole(const char * format, …);
	Python	def PrintToServerConsole(format)
Returns	Type	int
	Value	error code
Remarks

Function	C++	WMX3APIFUNC PrintToServerConsole(const wchar_t * format, …);
	Python
Returns	Type
	Value
Remarks

Function	C++	wmx3Api::WMX3Api:: WMX3APIFUNC RecordWindowsUpdates(unsigned int waitTimeMilliseconds); “ WMX3APIFUNC RecordWindowsUpdates(unsigned int waitTimeMilliseconds = 0);”
	Python	def RecordWindowsUpdates()
Returns	Type	int
	Value	error code
Remarks

Function	C++	wmx3Api::WMX3Api:: WMX3APIFUNC RecordWindowsUpdates(unsigned int waitTimeMilliseconds); “ WMX3APIFUNC RecordWindowsUpdates(unsigned int waitTimeMilliseconds = 0);”
	Python	def RecordWindowsUpdates(waitTimeMilliseconds)
Returns	Type	int
	Value	error code
Remarks

Function	C++	wmx3Api::WMX3Api:: WMX3APIFUNC CompareWindowsUpdates(unsigned int waitTimeMilliseconds); “ WMX3APIFUNC CompareWindowsUpdates(unsigned int waitTimeMilliseconds = 0);”
	Python	def CompareWindowsUpdates()
Returns	Type	int
	Value	error code
Remarks

Function	C++	wmx3Api::WMX3Api:: WMX3APIFUNC CompareWindowsUpdates(unsigned int waitTimeMilliseconds); “ WMX3APIFUNC CompareWindowsUpdates(unsigned int waitTimeMilliseconds = 0);”
	Python	def CompareWindowsUpdates(waitTimeMilliseconds)
Returns	Type	int
	Value	error code
Remarks