CmEmbedded_4c_transp Types, macros and helper functions

  • C, C++

Base types

Description

This type represents an unsigned 32-bit integer value.

Description

This type represents an unsigned 32-bit integer value.

Description

This type represents an unsigned 16-bit value.

Description

This type represents an unsigned 8-bit value. It is declared as an unsigned char.

Handles

Description

HCMSysEntry is a 32-bit value which can be seen as a handle that points to a Product Item, a Firm Item, a CmContainer or a subsystem. Such a handle can be created by CmAccess2.

Macros

Description

CM_SET_VERSION(a, b, c) sets the complete version in a CMULONG value.

•a: sets the major version.

•b: sets the minor version.

•c: sets the build version.

Syntax

#define CM_SET_VERSION(a,b,c) (((a) & 0xff) \

(((a) & 0xff) << 24) | (((b) & 0xff) << 16) | ((c) & 0xffff)

Description

CM_GET_MAJOR_VERSION(v) gets major version from a complete version value.

•v: complete version value.

Syntax

#define CM_GET_MAJOR_VERSION(v) (((v) >> 24) & 0xff)

Description

CM_GET_MINOR_VERSION(v) gets minor version from a complete version value.

•v: complete version value.

Syntax

#define CM_GET_MINOR_VERSION(v) (((v) >> 16) & 0xff)

Description

CM_GET_BUILD_VERSION(v) gets the build version from a complete version value.

•v: complete version value.

Syntax

#define CM_GET_BUILD_VERSION(v) ((v) & 0xffff)

Helper functions

Description

CmConvertTime as a helper function converts calendar date specifications into seconds since 2000-01-01T00:00 and vice versa.

Syntax

CODEMETER_API int CMAPIENTRY CmConvertTime(CMULONG flCtrl, CMTIME *pcmtime);

Parameter

flCtrl specifies the following flags.

nav_open CM_CONVERT_SECONDS_TO_CALENDAR specifies that the time is converted from "seconds since 2000" to a calender date.

nav_open CM_CONVERT_CALENDAR_TO_SECONDS specifies that the the time is converted from a calender date to "seconds since 2000".

CMTIME contains a given hmtoggle_plus1 CMTIME structure as part of API calls, for example, CmAccess2, etc.

Structure CMTIME

CMTIME sets or gets the time to or from a CmContainer.

Syntax

typedef struct __CMTIME {

CMUSHORT musYear;

CMUSHORT musMonth;

CMUSHORT musDay;

CMUSHORT musHours;

CMUSHORT musMinutes;

CMUSHORT musSeconds;

CMULONG mulSecondsSince01_01_2000;

} CMTIME;

Parameter

musYear specifies the value of the year (e.g. 2003).

musMonth specifies the value of the month (1..12).

musDay specifies the value of the day (1..31).

musHours specifies the value of the hours (0..23).

musMinutes specifies the value of the minutes (0..59).

musSeconds specifies the value of the seconds (0..59).

mulSecondsSince01_01_2000 specifies the time in seconds since 01/01/2000.

 

pcmtime contains the conversion time result according to the specified flag.

Return

If CM_CONVERT_SECONDS_TO_CALENDAR is specified, *pcmtime holds valid amount of seconds (unequal 0) since 2000-01-01T00:00.

If CM_CONVERT_CALENDAR_TO_SECONDS is specified, *pcmtime holds valid calender date.