IMMHourMinSecTime

The IMMHourMinSecTime datatype class represents the hours-minutes-seconds (HHMMSS) time format.


IMMHourMinSecTime - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


[view class]
~IMMHourMinSecTime
public:
virtual ~IMMHourMinSecTime()

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
IMMHourMinSecTime


Overload 1
public:
IMMHourMinSecTime(const IMMTime& time)

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Overload 2
public:
IMMHourMinSecTime(const IMMHourMinSecTime& time)

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Overload 3
public:
IMMHourMinSecTime(unsigned long value = defaultTime)

You can construct an IMMHourMinSecTime from the following:

value
A time value where:
  1. 1st byte is reserved(and not used)
  2. 2nd byte is the seconds
  3. 3rd byte is the minutes
  4. 4th byte is the hours

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Attributes

Use these functions to parse the time into normal time values, for example, hours, minutes, and seconds.


[view class]
hours
public:
virtual unsigned long hours() const

Returns the hours component of the time.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
minutes
public:
virtual unsigned long minutes() const

Returns the minutes component of the time. This is in the range of 0 to 59.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
seconds
public:
virtual unsigned long seconds() const

Returns the seconds component of the time. This is in the range of 0 to 59.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Conversions

Use these members to cast the time to an unsigned long.


[view class]
operator unsigned long
public:
virtual operator unsigned long() const

Returns the time as a unsigned long in the following format (RRSSMMHH):

  1. 1st byte is reserved
  2. 2nd byte is the seconds
  3. 3rd byte is the minutes
  4. 4th byte is the hours

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Diagnostics

Use these members to return the time as a string.


[view class]
asString
public:
virtual IString asString() const

Returns the time value as a string formatted as HH:MM:SS.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Ordinal

Use these ordinal number functions for indicating generic positions. A time object returns an ordinal number, which represents the time at some particular granularity. This is useful for something that allows seeking and displays position, such as a slider. Because sliders generally do not process time values, use an ordinal number to establish the range of slider values. Ordinal numbers can be mathematically manipulated and converted back to time values, if necessary.
Note: Some time values are difficult to represent as an ordinal value, such as IMMTrackMinSecFrameTime. Such a time object produces ordinal numbers that are dependent on unknown information, such as the table of contents of a CD. Some time classes might not be able to correctly implement setTimeToOrdinal.


[view class]
ordinal
public:
virtual unsigned long ordinal() const

Returns the time value in total seconds.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
setTimeToOrdinal
public:
virtual IMMTime& setTimeToOrdinal(unsigned long ordinal)

Sets the time object to the value represented by the ordinal number (in seconds).

Supported Platforms

Windows OS/2 AIX
Yes Yes No


IMMHourMinSecTime - Inherited Member Functions and Data

Inherited Public Functions

IMMTime

Inherited Public Data

IMMTime

Inherited Protected Functions

IMMTime

Inherited Protected Data