NxLib API > C++ Interface > NxLibItem

Waits until the item has a specific value.

Signatures

Variants throwing exceptions on API errors:

void waitForValue(int value, bool waitForEqual) const

void waitForValue(double value, bool waitForEqual) const

void waitForValue(bool value, bool waitForEqual) const

void waitForValue(std::string value, bool waitForEqual) const

void waitForValue(char const * const value, bool waitForEqual) const

Variants returning API errors as int* parameter:

void waitForValue(int* returnCode, int value, bool waitForEqual) const

void waitForValue(int* returnCode, double value, bool waitForEqual) const

void waitForValue(int* returnCode, bool value, bool waitForEqual) const

void waitForValue(int* returnCode, std::string value, bool waitForEqual) const

void waitForValue(int* returnCode, char const * const value, bool waitForEqual) const

Parameters

returnCode	The error code returned when accessing the item.
value	The value to wait for.
waitForEqual	Indicates whether to wait until the item has the given value, or whether to wait until the item has a value different than the specified one.

none