nn::nex::Session::SetUserDefinedState Member Function

Syntax

qBool SetUserDefinedState(
     qUnsignedInt32 uiNewState
);

Parameters

Name Description
in uiNewState Specifies a new, user-defined value.

Return Values



Value Description
true Returned when the setting succeeded.
false Returned when the setting failed. A SYSTEMERROR_OBJDUP_INVALID_ON_DUPLICA error is signaled when this function was called by a station other than the session master.

Description

Sets a user-defined value.

User-defined values are not used by Net-Z. Net-Z merely duplicates these values on all participating stations. This function can only be called by the session master. Use it with session masters to set and distribute information. Other stations should use it merely to accept that information.

See Also

GetUserDefinedState, DuplicatedObject::IsADuplicationMaster

Revision History

2011/01/27
Initial version.

CONFIDENTIAL