Classes > TracksBoard class > Methods > TracksBoard.ItemLockStateSet method

Remarks

Modifies the lock state of the given item. The current lock state can be modified through the TracksBoard.ItemLockStateGet method.

The full track can be locked through the TracksBoard.TrackLockStateSet method.

In case you should only need to lock the position of the item, allowing to continue modifying existing volume points and the amplitude line, the alternative would be the TracksBoard.ItemPositionLockStateSet method.

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 ItemLockStateSet (

nUniqueId as Int32,

bLocked as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes ItemLockStateSet (

Int32 nUniqueId,

bool bLocked

);

[C++]

public: enumErrorCodes ItemLockStateSet (

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 must be locked.

Supported values are the following:

Value	Meaning
false	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