TracksBoard.TrackLockStateGet method |
|
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 class section.
Syntax
[Visual Basic] Public Function TrackLockStateGet ( nTrack as Int32, ByRef bIsLocked as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes TrackLockStateGet ( Int32 nTrack, ref bool bIsLocked ); |
[C++] public: enumErrorCodes TrackLockStateGet ( Int32 nTrack, bool __gc *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:
|
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 |