Classes > TracksBoard class > Methods > TracksBoard.ItemPositionLockStateSet method

Remarks

Modifies the lock state of the position for the given item. The current lock state can be obtained through the TracksBoard.ItemPositionLockStateGet method.

Differently from the TracksBoard.ItemLockStateSet method, where a single item is totally locked, when the item's position only is locked, existing volume points and the amplitude line can still be moved but the possibility to move the item around is denied.

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard object section.

Syntax

[Visual Basic]

Public Function ItemPositionLockStateSet (

nUniqueId as Int32,

bLocked as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes ItemPositionLockStateSet (

Int32 nUniqueId,

bool bLocked

);

[C++]

public: enumErrorCodes ItemPositionLockStateSet (

Int32 nUniqueId,

bool bLocked

);

Parameter

Description

nUniqueId

Unique identification number assigned to the sound item after being generated by one of the following methods:

•	TracksBoard.ItemSoundFileAdd and TracksBoard.ItemSoundFileRawAdd for sound files

•	TracksBoard.ItemSpeechFromStringAdd and TracksBoard.ItemSpeechFromFileAdd for text to speech items

•	TracksBoard.ItemClone when an existing item has been cloned

bLocked

Boolean value indicating if the item's position must be locked.

Supported values are the following:

Value	Meaning
false (default)	The item is not locked.
true	The item is locked.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful