Classes > TracksBoard class > Methods > TracksBoard.ItemLockStateGet method

Remarks

Obtains the lock state of the given item. The current lock state can be modified through the TracksBoard.ItemLockStateSet 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 ItemLockStateGet (

nUniqueId as Int32,

ByRef bIsLocked as Boolean

[C#]

public enumErrorCodes ItemLockStateGet (

Int32 nUniqueId,

ref bool bIsLocked

);

[C++]

public: enumErrorCodes ItemLockStateGet (

Int32 nUniqueId,

bool __gc *bIsLocked

);

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

bIsLocked

Reference that, after returning from the method call, will contain a boolean value indicating if the item is locked.

Supported values are the following:

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