Copyright © 2006-2018 MultiMedia Soft

WaveformAnalyzer.SettingsRulersTimeFormatSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the format for displaying strings of time position on time rulers of the waveform analyzer.

 

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer object section.

 

 

Syntax

 

[Visual Basic]

control.WaveformAnalyzer.SettingsRulersTimeFormatSet (

bShowHour as enumBoolean,

nNumberOfMsDigits as Integer,

strHourSeparator as String,

strMsSeparator as String,

bRemoveZeroes as enumBoolean,

) as String


 

[C++]

LPCTSTR control.WaveformAnalyzer.SettingsRulersTimeFormatSet (

short bShowHour,

short nNumberOfMsDigits,

BSTR strHourSeparator,

BSTR strMsSeparator,

short bRemoveZeroes

);


 

 

Parameter

Description

 

 

bShowHour

Boolean value that specifies to avoid displaying the 'hour' position field.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Doesn't show hour value

BOOL_TRUE (default)

1

Shows hour value

nNumberOfMsDigits

Number of characters used to represent milliseconds digits, can be in the range from 1 to 3; values outside this range will be automatically set to 3.

strHourSeparator

Character used to separate hours, minutes and seconds, typically this should be set to ":"

strMsSeparator

Character used to separate seconds and milliseconds, typically this should be set to "."

bRemoveZeroes

Boolean value that specifies to remove zeroes at the beginning and end of the string.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE (default)

0

Doesn't remove zeroes

BOOL_TRUE

1

Removes zeroes

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.