Copyright © 2001-2023 MultiMedia Soft

TracksBoard.TrackLockStateGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the lock state of the given track. The lock state can be modified through the TracksBoard.TrackLockStateSet 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]

control.TracksBoard.TrackLockStateGet (

nTrack as Integer,

ByRef bIsLocked as enumBoolean

) as enumErrorCodes


 

[C++]

short control.TracksBoard.TrackLockStateGet (

short nTrack,

long *bIsLocked

);


 

Parameter

Description

 

 

nTrack

Zero-based index of the track. The current number of tracks can be obtained through the TracksBoard.TracksCountGet method.

bIsLocked

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

Supported values are the following:

Value

Meaning

BOOL_FALSE (default)

The track is not locked.

BOOL_TRUE

The track 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