Copyright © 2013-2014 MultiMedia Soft

MidiDjConsole.DisplaySegmentStringShow method

Previous pageReturn to chapter overviewNext page

Remarks

 

Displays a string of characters on the given VFD segment.

 

If you need to display a single character instead of a string of characters, use the MidiDjConsole.DisplaySegmentSymbolShow method.

In case the string to display should be longer respect to the available number of cells per segment, you could make the string scrolling at a given rate through the MidiDjConsole.DisplaySegmentStringScroll method.

 

You can verify if the control comes with support for managing VFD segments of the connected DJ Console through the MidiDjConsole.DisplaySegmentManagementAvailable method.

 

For further details about interfacing with MIDI DJ Consoles see the MidiDjConsole object section and the How to manage MIDI DJ consoles tutorial.

 

 

Syntax

 

[Visual Basic]

control.MidiDjConsole.DisplaySegmentStringShow (

nIndex as Long,

pBuffer as Variant,

nBufferLen as Long

) as enumDjcErrorCodes


 

[C++]

short control.MidiDjConsole.DisplaySegmentStringShow (

long nIndex,

const VARIANT FAR& pBuffer,

long nBufferLen

);


 

Parameter

Description

 

 

nIndex

Zero-based index of the VFD segment. The maximum number of available segments can be retrieved through the MidiDjConsole.DisplaySegmentCountGet method.

pBuffer

Variant parameter containing the pointer to the memory buffer containing the string to display.

The character set in use is usually provided inside the technical specifications of the DJ Console in use.

nBufferLen

Length in bytes of the given buffer. Usually one single byte is required to store one single character.

The length of the buffer can be up to 256 bytes. In case the source buffer should have a size larger than the total number of segment's cells, only the first bytes corresponding to the number of cells would be taken into consideration while bytes exceeding this size would be ignored.

The maximum number of cells available for the given segment can be obtained through the MidiDjConsole.DisplaySegmentInfoGet method.

In case the given buffer should be smaller than the number of available cells, remaining cells would be automatically filled with blank characters.

 

 

Return value

 

Value

Meaning

 

 

enumDjcErrorCodes.ERR_DJC_NOERROR (0)

The call was successful.

Negative value

An error occurred: see the LastError property for further error details or for a list of the possible error values.