Method SetValueHelp

cpp/src/Manager.cpp:1896–1925

----------------------------------------------------------------------------- Sets a help string describing the value's purpose and usage -----------------------------------------------------------------------------

// Sets a help string describing the value's purpose and usage
//-----------------------------------------------------------------------------
void Manager::SetValueHelp
(
		ValueID const& _id,
		string const& _value,
		int32 _pos
)
{
	if( Driver* driver = GetDriver( _id.GetHomeId() ) )
	{
		LockGuard LG(driver->m_nodeMutex);
		if (_pos != -1) {
			if (_id.GetType() != ValueID::ValueType_BitSet) {
				OZW_ERROR(OZWException::OZWEXCEPTION_INVALID_VALUEID, "ValueID passed to SetValueHelp is not a BitSet but a position was requested");
				return;
			}
			ValueBitSet *value = static_cast<ValueBitSet *>(driver->GetValue( _id ));
			value->SetBitHelp(_pos, _value);
			value->Release();
			return;
		} else {
			if( Value* value = driver->GetValue( _id ) )
			{
				value->SetHelp( _value );
				value->Release();
				return;
			}
		}
	}
	OZW_ERROR(OZWException::OZWEXCEPTION_INVALID_VALUEID, "Invalid ValueID passed to SetValueHelp");
}

//-----------------------------------------------------------------------------
// <Manager::GetValueMin>