CmEmbedded_4c_transp CmGetInfo

Description

CmGetInfo returns data related to the opened entry.

  • C, C++

Syntax

int CMAPIENTRY CmGetInfo(HCMSysEntry hcmse, CMULONG flCtrl, void *pvDest, CMUINT cbDest)

Parameter

hcmse contains the handle opened by CmAccess2.

flCtrl The following flags can be set:

nav_open CM_GEI_BOXCONTROL fills a hmtoggle_plus1 CMBOXCONTROL structure specified in pvDest.

Structure CMBOXCONTROL

The CmDongle controller chip may support some digital output and some digital input lines, generally named as Control Lines. The CmDongle architecture supports following lines store in the CMBOXCONTROL structure:

•Up to 16 Indicator Control Lines are controlled (powered) by the chip. They may be set to 0 or 1, for example to supply a LED (Light Emitting Diode).

•Up to 16 Switcher Control Lines are read by the chip. Their read value may be 0 or 1, for example controlled by a switcher or button.

Syntax

typedef struct __CMBOXCONTROL {

CMUSHORT musIndicatorFlags;

CMUSHORT musSwitchFlags;

CMULONG mulReserve;

} CMBOXCONTROL;

Parameter

musIndicatorFlags contains the current setting of the indicator control lines.

musSwitchFlags contains the current setting of the switcher control lines.

mulReserve is reserved for future purposes.

 

nav_open CM_GEI_BOXINFO fills a hmtoggle_plus1 CMBOXINFO structure specified in pvDest.

Structure CMBOXINFO

This structure contains information on a CmContainer.

Syntax

typedef struct __CMBOXINFO {

CMBYTE mbMajorVersion;

CMBYTE mbMinorVersion;

CMUSHORT musBoxMask;

CMULONG mulSerialNumber;

CMUSHORT musBoxKeyId;

CMUSHORT musUserKeyId;

CMBYTE mabBoxPublicKey[CM_PUBLIC_KEY_LEN];

CMBYTE mabSerialPublicKey[CM_PUBLIC_KEY_LEN];

CMULONG mulReserve;

} CMBOXINFO;

Parameter

mbMajorVersion contains the major version of the CmContainer.

mbMinorVersion contains the minor version of the CmContainer.

musBoxMask contains the box mask of the CmContainer.

mulSerialNumber contains the serial number of the CmContainer.

musBoxKeyId contains the ID of the used BoxKey of the CmContainer.

musUserKeyId contains the ID of the used UserKey of the CmContainer.

mabBoxPublicKey[CM_PUBLIC_KEY_LEN] contains the public Box Key of the CmContainer.

mabSerialPublicKey[CM_PUBLIC_KEY_LEN] contains the public Serial Key of the CmContainer.

mulReserve is reserved for future purposes.

Notes

The length of the mabBoxPublicKey and mabSerialPublicKey is 64 byte long. The used public key are currently 224 bits = 28 bytes long. In Elliptic Curve Cryptography the public key is a 2 dimensional point, so the x-value is stored in the first 28 bytes (0..27) and the y-value is store in byte 32..59.

 

nav_open CM_GEI_BOXTIME fills a hmtoggle_plus1 CMBOXTIME structure specified in pvDest.

Structure CMBOXTIME

CMBOXTIME returns the three values of time clocks: Certified, Box and System Time.

Syntax

typedef struct __CMBOXTIME {

CMTIME mcmCertifiedTime;

CMTIME mcmBoxTime;

CMTIME mcmSystemTime;

} CMBOXTIME;

Parameter

mcmCertifiedTime contains the Certified Time(see hmtoggle_plus1 CMTIME structure).

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.

 

mcmBoxTime contains the Box Time (see CMTIME).

mcmSystemTime contains the System Time (see CMTIME).

 

nav_open CM_GEI_ENTRYINFO2 fills a hmtoggle_plus1 CMBOXENTRY2 structure specified in pvDest.

Structure CMBOXENTRY2

CMBOXENTRY2 contains data of one entry. An entry is containing one Firm Item and one Product Item. In this structure all static data are stored. The dynamic data must read out of the CmContainer explicitly.

Syntax

typedef struct __CMBOXENTRY2 {

CMULONG mflFiCtrl;

CMULONG mulFirmCode;

CMUSHORT musFirmAccessCounter;

CMULONG mulFirmUpdateCounter;

CMULONG mulFirmPreciseTime;

CMUSHORT mausFirmItemText[CM_MAX_STRING_LEN];

CMULONG mflSetNativePios;

CMULONG mflSetEffectivePios;

CMULONG mflSetPios;

/* Product Item data */

CMULONG mulProductCode;

CMULONG mulFeatureMap;

CMTIME mcmMaintenancePeriodStart;

CMTIME mcmMaintenancePeriodEnd;

CMULONG mulUnitCounter;

CMTIME mcmExpirationTime;

CMTIME mcmActivationTime;

CMULONG mulUsagePeriodLifeTime;

CMTIME mcmUsagePeriodStartTime;

CMULONG mulLicenseQuantity;

CMULONG mflLicenseQuantityFlags;

CMULONG mulLicenseTag;

CMULONG mflTransferStatus;

CMBYTE mabProductItemId[10];

CMBYTE mabReserve2[20];/* aligned to 796 */

CMUSHORT musMaxEncryptionRate;

CMBYTE mfbDependencyPC;

CMBYTE mfbDependencyFM;

CMBYTE mfbDependencyMP;

CMBYTE mfbDependencyUC;

CMBYTE mfbDependencyET;

CMBYTE mfbDependencyAT;

CMBYTE mfbDependencyUP;

CMBYTE mfbDependencyLQ;

CMBYTE mfbDependencyLT;

CMBYTE mfbDependencyMV;

CMUSHORT musModuleRef;

CMUSHORT musProductItemRef;

CMUSHORT musTransferBoxMask;

CMULONG mulTransferSerialNumber;

CMTIME mcmTransferBorrowExpirationTime;

CMBYTE mabTransferId[10];

} CMBOXENTRY2;

Parameter

mflFiCtrl specifies the type of the Firm Item. The following flags can be set:

nav_open CM_GF_BOXBASED specifies that the Firm Item was programmed in the Box-Based-Mode.

nav_open CM_GF_FILEBASED specifies that the Firm Item was programmed in the File-Based-Mode.

nav_open CM_GF_TRANSFERBASED specifies that the Firm Item has been created based on a license transfer.

nav_open CM_GF_FI_ALLOWED_TO_PULL specifies the license transfer can be actively performed.

nav_open CM_GF_FI_RESERVED specifies that the Firm Item is a Reserved Firm Item.

mulFirmCode contains the Firm Code of the Firm Item.

musFirmAccessCounter contains the Firm Access Counter of the Firm Item.

mulFirmUpdateCounter contains the Firm Update Counter of the Firm Item.

mulFirmPreciseTime contains the FirmPreciseTime of the Firm Item.

mausFirmItemText[CM_MAX_STRING_LEN] contains the Firm Item Text of the Firm Item.

mflSetNativePios specifies in the context of used Module Items the native representation of the PIOs as programmed.

mflSetEffectivePios specifies in the context of used Module Items the effective representation, i.e including eventually inherited PIOs.

mflSetPios specifies all available PIO's at this Product Item. The following flags can be set:

nav_open CM_BE_PRODUCTCODE specifies that the Product Item contains a Product Code.

nav_open CM_BE_FEATUREMAP specifies that the Product Item contains a Feature Map.

nav_open CM_BE_EXPTIME specifies that the Product Item contains a Expiration Time.

nav_open CM_BE_ACTTIME specifies that the Product Item contains a Activation Time.

nav_open CM_BE_UNITCOUNTER specifies that the Product Item contains a Unit Counter.

nav_open CM_BE_PROTDATA specifies that the Product Item contains a Protected Data.

nav_open CM_BE_EXTPROTDATA specifies that the Product Item contains one or more Extended Protected Data.

nav_open CM_BE_HIDDENDATA specifies that the Product Item contains one or more Hidden Data.

nav_open CM_BE_SECRETDATA specifies that the Product Item contains one or more Secret Data.

nav_open CM_BE_USERDATA specifies that the Product Item contains a User Data.

nav_open CM_BE_TEXT specifies that the Product Item contains a Text.

nav_open CM_BE_USAGEPERIOD specifies that the Product Item contains a Usage Period.

nav_open CM_BE_LICENSEQUANTITY specifies that the Product Item contains a License Quantity.

information_weiss_klein26

Please note that borrowing in this context does not involve a license transfer. Rather it refers to borrowing using Firm Codes smaller than 6,000,000 and especially prepared CmContainer.

nav_open CM_BE_BORROWCLIENT specifies that the Product Item contains a Borrow Client entry.

nav_open CM_BE_BORROWSERVER specifies that the Product Item contains a Borrow Server entry.

nav_open CM_BE_COLI specifies that the Product Item contains a Customer Owned License Information (COLI).

nav_open CM_BE_MAINTENANCEPERIOD specifies that the Product Item contains a Maintenance Period entry.

nav_open CM_BE_LINGERTIME specifies that the Product Item contains a Linger Time entry.

nav_open CM_BE_MINIMUMVERSION specifies that the Product Item contains a Minimal Runtime Version entry.

nav_open CM_BE_MODULE_ITEM specifies that the Product Item contains a Module Item, if available.

nav_open CM_BE_BORROWEXPIRATIONTIME specifies that the Product Item contains a borrowing entry based on a license transfer, if available.

nav_open CM_BE_HISTORY specifies that the Product Item is part of a license transfer process, if available.

nav_open CM_BE_ACCESS_PASSWORD specifies that the Product Item contains a password, if available.

nav_open CM_BE_TRANSFEROPTIONS specifies that the Product Item contains license transfer options, if available.

nav_open CM_BE_RETURNINFO specifies that the Product Item contains license transfer return information, if available.

nav_open CM_BE_ACCEPTSPULL specifies that the Product Item contains the information that a license can be pulled, if available.

nav_open CM_BE_NAMEDUSER specifies that the Product Item contains a Named User entry, if available.

nav_open CM_BE_MAX_ENCRYPTION_RATE specifies that the Product Item contains a Maximum Encryption Rate information.

nav_open CM_BE_PIO_MASK specifies all flags for the Product Item Options.

mulProductCode contains the Product Code of the Product Item.

mulFeatureMap contains the Feature Map of the Product Item.

mcmMaintenancePeriodStart contains the start date of the Maintenance Period of the Product Item, if available.

mcmMaintenancePeriodEnd contains the end date of the Maintenance Period of the Product Item, if available.

mulUnitCounter contains the Unit Counter of the Product Item, if available.

mcmExpirationTime contains the Expiration Time of the Product Item, if available (see hmtoggle_plus1 CMTIME structure).

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.

 

mcmActivationTime contains the Activation Time of the Product Item, if available (see CMTIME).

mulUsagePeriodLifeTime contains the period length of the Usage Period in seconds, if available.

mcmUsagePeriodStartTime contains the start time of the Usage Period, if available (see CMTIME).

mulLicenseQuantity contains the License Quantity of the Product Item, if available.

mflLicenseQuantityFlags contains the flags for license access options, i.e. local accesses.

nav_open CM_LQ_DENIEDUSERLIMIT

nav_open CM_LQ_DENIEDNOUSERLIMIT

nav_open CM_LQ_DENIEDEXCLUSIVE

nav_open CM_LQ_DENIEDSTATIONSHARE

nav_open CM_LQ_ALLOWCMWAN

nav_open CM_LQ_TRIPLEMODEREDUNDANCY

nav_open CM_LQ_LOCALACCESSONLY

nav_open CM_LQ_DENIEDALL

nav_open CM_LQ_MAXVALUE

mulLicenseTag contains information in the context of Triple Mode Redundancy feature if available.

mflTransferStatus contains the flag of the transfer status. The following flags exist:

nav_open CM_TRANSFER_STATUS_ENABLED 1

nav_open CM_TRANSFER_STATUS_DISABLED 2

nav_open CM_TRANSFER_STATUS_RETURNED 3

nav_open CM_TRANSFER_STATUS_EXPIRED 4

mabProductItemId contains an unique identifier for the Product Item.

musMaxEncryptionRate contains the Maximum Encryption Rate.

mfbDependencyPC contains the dependency flags of the Product Code.

mfbDependencyFM contains the dependency flags of the Feature Map.

mfbDependencyUC contains the dependency flags of the Unit Counter.

mfbDependencyET contains the dependency flags of the Expiration Time.

mfbDependencyAT contains the dependency flags of the Activation Time.

mfbDependencyUP contains the dependency flags of the Usage Period.

mfbDependencyLQ contains the dependency flags of the License Quantity.

mfbDependencyLT contains the dependency flags of the Linger Time.

mfbDependencyMV contains the dependency flags of the Minimum Runtime Version.

musModuleRef contains the Product Item Reference of the super-ordinated Product Item of a Module Item. All items of a module then have the same ModulRef if available.

musProductItemRef holds the Product Item Reference.

musTransferBoxMask holds the box mask of the source in the case of a transferred license if available.

mulTransferSerialNumber holds the serial number of the source in the case of a transferred license if available.

mcmTransferBorrowExpirationTime holds the time at which a borrowed license (license transfer) expires if available.

mabTransferId[10] holds the Id of the transfer (corresponds to the Id in the history item of the sender) if available.

Notes

The dynamic data can be read out with GetInfo()/CM_GEI_ENTRYDATA.

The dependency parameters (mfbDependencyXX) can be have one or more of the following flags:

•CM_GF_DATA specifies that the parameter depends on the contents of the data of the Firm Item.

•CM_GF_FUC specifies that the parameter depends on the Firm Update Counter of the Firm Item.

•CM_GF_SERIAL specifies that the parameter depends on the Serial Number of the CmContainer.

On Windows the mausFirmItemText array can be simply converted via CmConvertString() into the specified character set.

CMBOXENTRY2 is supported since CodeMeter Version 4.30.

The flags CM_GF_TRANSFERBASED and CM_GF_FI_ALLOWED_TO_PULL of mflFiCtrl are available since CodeMeter Version 6.00.

The members musModuleRef, musTransferBoxMask, mulTransferSerialNumber, mcmTransferBorrowExpirationTime, mabTransferId, mflLicenseQuantityFlags are available since CodeMeter Version 6.00.

The member musMaxEncryptionRate is available since CodeMeter Version 6.50.

For mflTransferStatus the flags CM_TRANSFER_STATUS_ENABLED, CM_TRANSFER_STATUS_DISABLED, CM_TRANSFER_STATUS_RETURNED, CM_TRANSFER_STATUS_EXPIRED: are available since CodeMeter Version 6.30.

For mflSetPio the flag CM_BE_NAMEDUSER is available since CodeMeter Version 6.30.

For mflSetPio the flags CM_BE_ACCESS_PASSWORD and CM_BE_MAX_ENCRYPTION_RATE is available since CodeMeter Version 6.50.

nav_open CM_GEI_ENTRYDATA fills a hmtoggle_plus1 CMENTRYDATA structure specified in pvDest. If more than one item is available, an array with matching or larger size must be passed.

Structure CMENTRYDATA

CMENTRYDATA contains a dynamic added data of a Product Item with all its properties.

Syntax

typedef struct __CMENTRYDATA {

CMULONG mflCtrl;

CMULONG mflDependency;

CMUINT mcbData;

CMBYTE mabData[2 * CM_MAX_STRING_LEN];

} CMENTRYDATA;

Parameter

mflCtrl specifies the type of the dynamic added entry. It can contain one of the following flags:

nav_open CM_GF_USERDATA specifies that the Product Item contains a User Data.

nav_open CM_GF_TEXT specifies that the Product Item contains a Text.

nav_open CM_GF_PROTDATA specifies that the Product Item contains a Protected Data.

nav_open CM_GF_EXTPROTDATA specifies that the Product Item contains one or more Extended Protected Data.

nav_open CM_GF_HIDDENDATA specifies that the Product Item contains one or more HiddenData Data.

nav_open CM_GF_SECRETDATA specifies that the Product Item contains one or more Secret Data.

nav_open CM_GF_USAGEPERIOD specifies that the Product Item contains a Usage Period.

For the three entry types Extended Protected Data, Hidden Data and Secret Data the index of this data type is or'ed in the upper two bytes. See remarks for a sample.

mflDependency contains the dependency of the dynamic added entry. It can be have one or more of the following flags:

nav_open CM_GF_DATA specifies that the parameter depends on the contents of the data of the Firm Item.

nav_open CM_GF_FUC specifies that the parameter depends on the Firm Update Counter of the Firm Item.

nav_open CM_GF_SERIAL specifies that the parameter depends on the Serial Number of the CmContainer.

mulReserve is reserved for future purposes.

mcbData contains the length of mabData, for text entries (CM_GF_TEXT) the number of characters, for all other types the number of stored bytes.

mabData[2 * CM_MAX_STRING_LEN] contains the data of the dynamic added entry with the length stored in mcbData. For text entries (CM_GF_TEXT) the byte array contains an UCS2-LE encoded null-terminated string.

Notes

To check the mflCtrl you can use the CM_GF_PIO_MASK to retrieve only the data type flag, e.g. mflCtrl & CM_GF_PIO_MASK. To retrieve the index of Extended Protected Data, Hidden Data or Secret Data you need to extract the upper two bytes of mflCtrl, e.g. by mflCtrl >> 16.

For an easier conversion of mabData it may be helpful to use CmConvertString().

 

nav_open CM_GEI_INTERNALENTRYINFO fills as many hmtoggle_plus1 CMINTERNALENTRYINFO structures as specified in pvDest that are necessary to store the information of all Product Items of same Product Code of a Firm Code.

Structure CMINTERNALENTRYINFO

CMINTERNALENTRYINFO stores internal data of an entry.

Syntax

typedef struct __CMINTERNALENTRYINFO {

CMUSHORT musFirmItemReference;

CMUSHORT musProductItemReference;

CMULONG mulFirmItemType;

CMULONG mulFirmUpdateCounter;

} CMINTERNALENTRYINFO;

Parameter

musFirmItemReference contains the Firm Item Reference in the CmContainer of the Firm Item.

musProductItemReference contains the Product Item Reference in the CmContainer of the Product Item.

mulFirmItemType specifies the type of the Firm Item. The following flags can be set:

nav_open CM_GF_BOXBASED specifies that the Firm Item was programmed in the box based mode.

nav_open CM_GF_FILEBASED specifies that the Firm Item was programmed in the file based mode.

nav_open CM_GF_TRANSFERBASED specifies that the Firm Item has been created based on a license transfer.

nav_open CM_GF_FI_RESERVED specifies that the Firm Item is a Reserved Firm Item.

mulFirmUpdateCounter contains the Firm Update Counter of the Firm Item.

mulReserve is reserved for future purposes.

 

nav_open CM_GEI_SYSTEMSTATUS fills a hmtoggle_plus1 CMSYSTEMSTATUS structure specified in pvDest.

Structure CMSYSTEMSTATUS

CMSYSTEMSTATUS stores system specific data.

Syntax

typedef struct __CMSYSTEMSTATUS {

 CMULONG mflStatusFlags;

 CMULONG mulServerStartTimeInSecondsSince01_01_2000;

} CMSYSTEMSTATUS;

Parameter

mflStatusFlags may contain the following bits set:

nav_open CM_SYSTEMSTATUS_RUNNING_AS_SERVICE (0x00000001) specifies that CodeMeter runs as Windows service or, in the case of other operating systems, with respective privileges.

nav_open CM_SYSTEMSTATUS_CMACT_ENABLED (0x00000002) specifies CmActLicense licenses are activated in the profiling and can be used.

nav_open CM_SYSTEMSTATUS_MSD_ENABLED (0x00000004) specifies that CmDongles are activated in the profiling as Mass Storage Devices (MSD) and can be used.

nav_open CM_SYSTEMSTATUS_HID_ENABLED (0x00000008) specifies that CmDongles are activated in the profiling as Human Interface Devices (HID) and can be used.

nav_open CM_SYSTEMSTATUS_CMACT_AVAILABLE (0x00000010) specifies that CmActLicense can be used (it is activated and CodeMeter runs as service).

mulServerStartTimeInSecondsSince01_01_2000 contains the start time of CodeMeter server in seconds since 01.01.2000, 00:00 (UTC).

 

nav_open CM_GEI_SIGNEDLIST fills byte buffer with a signed list of an entry passed in pvDest.

nav_open CM_GEI_VERSION fills a hmtoggle_plus1 CMVERSION structure specified in pvDest.

Structure CMVERSION

CMVERSION stores the complete version of a CodeMeter module.

Syntax

typedef struct __CMVERSION {

CMUSHORT musVersion;

CMUSHORT musSubVersion;

CMUSHORT musBuild;

CMUSHORT musCount;

CMUSHORT musYear;

CMUSHORT musMonth;

CMUSHORT musDay;

} CMVERSION;

Parameter

musVersion contains the major version of the CodeMeter module.

musSubVersion contains the minor version of the CodeMeter module.

musBuild contains the build number of the CodeMeter module.

musCount contains the count of the CodeMeter module.

musYear contains the year of creation of the CodeMeter module.

musMonth contains the month of creation of the CodeMeter module.

musDay contains the day of creation of the CodeMeter module.

 

nav_open CM_GEI_CHIPINFO fills a hmtoggle_plus1 CMCHIPINFO structure specified in pvDest.

Structure CMCHIPINFO

CMCHIPINFO stores the information about the Chip of the CmDongle.

Syntax

typedef struct __CMCHIPINFO {

CMULONG mulFirmwareBuild;

CMULONG mulFirmwareBuildTop;

CMULONG mulMdfaLba;

CMULONG mulReserved;

CMUSHORT musChipType;

CMUSHORT musSiliconRevision;

CMUSHORT midFactory;

CMUSHORT musProductYear;

CMUSHORT musLotNumber;

CMUSHORT midWafer;

CMUSHORT midChipOnWafer;

CMUSHORT musDowngradeCount;

} CMCHIPINFO;

Parameter

mulFirmwareBuild contains the build number of the currently stored Firmware version.

mulFirmwareBuildTop contains the highest build number of the Firmware version ever stored.

mulMdfaLba contains the start address of the File I/O communication.

mulReserved is reserved for future purposes.

musChipType contains the type of the chip.

musSiliconRevision contains the revision of the chip mask.

midFactory contains the identification of the chip fabric where it was manufactured.

musProductYear contains the production year in number of years since 2000.

musLotNumber contains the charge number of the produced wafer.

midWafer contains the identification of the wafer within the charge.

midChipOnWafer contains the identification of the chip within the wafer.

musDowngradeCount

 

Structure CMUSBCHIPINFO

CMUSBCHIPINFO stores the information about the USB chip of the CmDongle.

Syntax

typedef struct __CMUSBCHIPINFO {

CMUSHORT musFirmwareMajor;

CMUSHORT musFirmwareMinor;

CMULONG  mulFlashSize;

char mszNodeDescription[CM_MAX_STRING_LEN];

CMBYTE mszNodes[CM_MAX_STRING_LEN];

} CMUSBCHIPINFO;

Parameter

musFirmWareMajor contains the major version of the USB chip Firmware.

musFirmWareMinor contains the minor version of the USB chip Firmware.

mulFlashSize contains the size of the flash memory part of the CmDongle.

mszNodeDescription contains the description of the current USB node of the connected CmDongle.

mszNodes contains a list of found CmDongle partitions. This feature requires a CodeMeter USB chip Firmware  version >= 7.3.

 

nav_open CM_GEI_BOXSTATUS fills a 32 bit value with following status flags.

nav_open CM_BOXSTATUS_LOWMEMORY specifies that the CmDongle has too low memory to replace damaged memory during normal usage.

nav_open CM_BOXSTATUS_REPLUG specifies that the CmDongle has initiated a Plug Out/In event for itself to force the operating system to remount the flash drive.

nav_open CM_BOXSTATUS_HASFLASH specifies that the CmDongle contains an additional flash disc besides the CodeMeter chip.

nav_open CM_BOXSTATUS_ISCMACT specifies that this is a CmActLicense.

nav_open CM_BOXSTATUS_REMOVABLE specifies the configuration of the CmDongle. This can be either be a fixed disk device or a removable disk device. The configuration of the CmDongle can be altered with CmConfigDisk on Windows.

nav_open CM_BOXSTATUS_BATTERY_POWERED_CLOCK_USED specifies that the hardware (CmStick/T) has a working battery powered clock inside.

nav_open CM_BOXSTATUS_USES_HID_COMMUNICATION specifies that the CmDongle is configured as Human Interface Device (HID).

nav_open CM_BOXSTATUS_STATE_FUM specifies that the CmDongle is in Field Update Mode (FUM). In this intermediate state an update of the Firmware version needs to be executed.

nav_open CM_BOXSTATUS_STATE_LOCKED specifies that the CmContainer is locked. This cannot be repaired. This CmContainer needs to be replaced.

Enabling status:

nav_open CM_BOXSTATUS_ENABLED specifies that the CmContainer is enabled.

nav_open CM_BOXSTATUS_DISABLED specifies that the CmContainer is disabled.

nav_open CM_BOXSTATUS_TEMPENABLED specifies that the CmContainer is temporarily enabled.

nav_open CM_BOXSTATUS_MASK specifies all flags for the enabling status.

CmActLicense status:

nav_open CM_ACTSTATUS_FILE specifies that a file is the base of this CmActLicense.

nav_open CM_ACTSTATUS_LOADED specifies that the CmActLicense is loaded and can be used. Used during the license creation on licensors side.

nav_open CM_ACTSTATUS_ACTIVATE_BY_CODE specifies that the CmActLicense can be activated by entering a code (phone activation).

nav_open CM_ACTSTATUS_ACTIVATE_BY_FILE specifies that the CmActLicense has to be activated by a file transmission of a Remote Update File.

nav_open CM_ACTSTATUS_ACTIVE specifies that the CmActLicense currently is valid and active.

nav_open CM_ACTSTATUS_PROGRAMMABLE specifies that this license can be programmed now. Used during the license creation on licensors side.

nav_open CM_ACTSTATUS_INVALID specifies that there occurred a problem with the security checks of the CmActLicense. The license cannot be used.

nav_open CM_ACTSTATUS_BROKEN specifies that the binding requirements are no longer fulfilled. The license cannot be used.

nav_open CM_ACTSTATUS_PSN_REQUIRED specifies that the licensee has to set a Product Serial Number (PSN) at the time of creating a remote context file.

nav_open CM_ACTSTATUS_VM_DETECTED specifies that the license is invalid since it is running in a virtual environment which is not permitted.

nav_open CM_ACTSTATUS_BLACKLISTED specifies that the CmActLicense is blacklisted by CodeMeter Timeserver and can no longer be used.

nav_open CM_BOXSTATUS_CMACT_MASK specifies all flags for CmActLicense.nav_open CM_GEI_LISTALLPI serves to faster return an array of Product Items and Module Items contents using internal lists and fills a hmtoggle_plus1 CMPIENTRYBASE structure specified in pvDest.

Structure CMPIENTRYBASE

CMPIENTRYBASE returns all Product Items and Module Items of the Firm Item regardless whether the handle is a Firm Item or Product Item handle.

Syntax

typedef struct __CMPIENTRYBASE {

 CMULONG mulProductCode;

 CMULONG mulFeatureMap;

 CMULONG mflSetEffectivePios;

 CMULONG mflSetNativePios;

 CMULONG mulMaintenancePeriodStartSecondsSince01_01_2000;

 CMULONG mulMaintenancePeriodEndSecondsSince01_01_2000;

 CMULONG mulUnitCounter;

 CMULONG mulExpirationTimeSecondsSince01_01_2000;

 CMULONG mulActivationTimeSecondsSince01_01_2000;

 CMULONG mulUsagePeriodLifeTime;

 CMULONG mulUsagePeriodStartTimeSecondsSince01_01_2000;

 CMULONG mulLicenseQuantity;

 CMULONG mulMinimumRuntimeVersion;

 CMULONG mflLicenseQuantityFlags;

 CMNAMEDUSER mcmNamedUserEntry;

 CMUSHORT musProductItemRef;

 CMUSHORT musReserved1;

 CMULONG mflTransferStatus;

} CMPIENTRYBASE;

Parameter

mulProductCode contains the Product Code of the Product Item.

mulFeatureMap contains the Feature Map of the Product Item.

mflSetEffectivePios specifies in the context of used Module Items the effective representation, i.e including eventually inherited PIOs.

mflSetNativePios specifies in the context of used Module Items the native representation of the PIOs as programmed.

mulMaintenancePeriodStartSecondsSince01_01_2000 contains the start date of the Maintenance Period of the Product Item in seconds since 01_01_2000, if available.

mulMaintenancePeriodEndSecondsSince01_01_2000 contains the end date of the Maintenance Period of the Product Item in seconds since 01_01_2000, if available.

mulUnitCounter contains the Unit Counter of the Product Item, if available.

mulExpirationTimeSecondsSince01_01_2000 contains the start date of the Expiration Time of the Product Item in seconds since 01_01_2000, if available.

mulActivationTimeSecondsSince01_01_2000 contains the end date of the Expiration Time of the Product Item in seconds since 01_01_2000, if available

mulUsagePeriodLifeTime contains the period length of the Usage Period in seconds, if available.

mulUsagePeriodStartTimeSecondsSince01_01_2000 contains the start date of the Usage Period of the Product Item in seconds since 01_01_2000, if available.

mulLicenseQuantity contains the License Quantity of the Product Item, if available.

mulMinimumRuntimeVersion contains the Minimum Runtime Version of the Product Item, if available.

mflLicenseQuantityFlags contains the flags for license access options, i.e. local accesses.

nav_open CM_LQ_DENIEDUSERLIMIT

nav_open CM_LQ_DENIEDNOUSERLIMIT

nav_open CM_LQ_DENIEDEXCLUSIVE

nav_open CM_LQ_DENIEDSTATIONSHARE

nav_open CM_LQ_ALLOWCMWAN

nav_open CM_LQ_TRIPLEMODEREDUNDANCY

nav_open CM_LQ_LOCALACCESSONLY

nav_open CM_LQ_DENIEDALL

nav_open CM_LQ_MAXVALUE

mcmNamedUserEntry holds the data of the respective a hmtoggle_plus1 CMNAMEDUSER structure.

Structure CMNAMEDUSER

CMNAMEDUSER stores the information about the PIO Named User. This PIO is used during CmAccess2() to verify the hashed CMACCESS2::mcmCredential.msz*** parameters Username, DomainName and UserDefinedText supplied in CmAccess2 against the hash of the credentials stored here.

Syntax

typedef struct __CMNAMEDUSER

{

 CMUSHORT musPioType;

 CMUSHORT musIndex;

 CMULONG mflDependency;

 CMULONG mulReserved;

 CMULONG mcbEntryData;

 CMBYTE mabTag[4];

 CMBYTE mbVersion;

 CMBYTE mbNextIndex;

 CMBYTE mbfModeFlags;

 CMBYTE mbReserved2;

 CMULONG mulCrc32;

 CMBYTE mabHash[32];

 CMBYTE mabPlaintext[128];

} CMNAMEDUSER;

Parameter

musPioType and mflDependency refer to the same-named parameter of the CMENTRYDATA structure. For internal use only.

musIndex identifies the named user entry.

mulReserved is reserved for future purposes.

mcbEntryData contains the length of the following data.

mabTag[4] contains always the tag "cmnu" (CodeMeter Named User) to uniquely identify the PioType Extended Protected Data.

mbVersion refers to the version number of cmnu; currently set to version 1.

mbNextIndex currently holds a value of 0.
In future, if there should be more than a single Named User License for each license (Firm Code: Product Code), contains the musIndex of the next Named User license entry. Valid values will be 128-255.

mbfModeFlags contains one of the following flags:

nav_open CM_NMU_MODE_USERNAME 0x01 (default) checks the login name only

nav_open CM_NMU_MODE_USERDOMAIN 0x02 checks the login name and the domain name

nav_open CM_NMU_MODE_USERDEFINED 0x03 checks the user defined text

nav_open CM_NMU_FLAG_PLAINTEXT 0x10 specifies that the credentials used with the selected mode are additionally stored in mabPlaintext..

mbReserved2 is reserved for future purposes.

mulCrc32 holds the internal value of the CRC32 encryption of mabTag up to (incl.) mbReserved2.

mabHash[32] holds the hash value generated during license creation.

mabPlaintext[128] holds, if flag CM_NMU_FLAG_PLAINTEXT has been set, the credentials used with the selected mode. The format is UTF-8.
If flag CM_NMU_FLAG_PLAINTEXT is not set, this field is empty.
For CM_NMU_MODE_USERDOMAIN the information is saved according to the pattern "domain name/ login name", e.g. "ABC Company/John Doe".

Notes

information_weiss_klein26

If no entries exist, the error CMERROR_NO_DATA_AVAILABLE (209) is returned.

If the buffer is too small, the error CMERROR_BUFFER_OVERFLOW (112) is returned.

If the handle is no entry handle, the error CMERROR_WRONG_HANDLE_TYPE (115) is returned.

 

musProductItemRef holds the Product Item Reference.

musReserved1 is reserved for future purposes.

mflTransferStatus contains the flag of the transfer status. The following flags exist:.

nav_open CM_TRANSFER_STATUS_ENABLED

nav_open CM_TRANSFER_STATUS_DISABLED

nav_open CM_TRANSFER_STATUS_RETURNED

nav_open CM_TRANSFER_STATUS_EXPIRED

 

pvDest contains pointer to a structure dependant to the flag set in flCtrl.

cbDest contains the length of pvDest in bytes.  

Return

The return value contains the real number of bytes returned in pvDest. If an error occurred, the return value is 0. If pvDest does not contain enough memory, the number of needed bytes will be returned. In this case, the return value is larger than the cbDest parameter and error code CMERROR_BUFFER_OVERFLOW is set.

Notes

This function does not really scan all available or desired ports for connected CmContainers because of CodeMeter License Servers Plug&Play mechanism and the implementation of storing all CmContainers and their content in internal lists. The function call checks the internal lists only and returns the matching data.

Since CodeMeter 3.30 CMNETINFOCLUSTER and CMNETINFOUSER is also filled when CodeMeter is not running as a network server. In older versions the error CMERROR_NO_NETWORK_SERVER is set, if CodeMeter License Server is not running as a server.

The following flags (and the corresponding functionality) are only available since CodeMeter Version 4.30:

•

•CM_BOXSTATUS_BATTERY_POWERED_CLOCK_USED

The following flag (and the corresponding functionality) is only available since CodeMeter Version 5.00:

•CM_BOXSTATUS_USES_HID_COMMUNICATION

The following flags (and the corresponding functionality) are only available since CodeMeter Version 6.00:

•CM_GEI_LTHISTORY

•CM_GEI_LTTRANSFEROPTIONS

The following flag (and the corresponding functionality) is only available since CodeMeter Version 6.30:

•CM_GEI_NAMEDUSER

•CM_GEI_LISTALLPI and CMPIENTRYBASE structure