CmpCodeMeter Library Documentation ¶ Company System Title CmpCodeMeter Version 3.5.18.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpCodeMeter Description 1 ¶ Library to get access to the CodeMeter license containers. Contents: ¶ CodeMClose (Function) CodeMDecrementUnitCounter (Function) CodeMDecrypt (Function) CodeMEncrypt (Function) CodeMGetContentByFirmcode (Function) CodeMGetContentByFirmcode2 (Function) CodeMGetExpirationTime (Function) CodeMGetFirst (Function) CodeMGetInfo (Function) CodeMGetName (Function) CodeMGetNext (Function) CodeMGetQuantity (Function) CodeMGetUnitCounter (Function) CodeMOpen (Function) GlobalConstants EventIDs (GVL) RTS_CMBOXENTRY (Struct) RTS_CODEMETER_INFO (Struct) Types EVTPARAM_CmpCodeMeterLicenseActivated (Struct) internal functions CodeMGetFeatureMapByFirmcode (Function) Indices and tables ¶ 1 Based on CmpCodeMeter.library, last modified 01.04.2022, 08:12:12. LibDoc 4.4.0.0-b.27 The content file CmpCodeMeter.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 01.04.2022, 08:12:12.

CodeMClose (FUN) ¶ FUNCTION CodeMClose : RTS_IEC_RESULT Close a license with the specified handle InOut: Scope Name Type Comment Return CodeMClose RTS_IEC_RESULT Error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded Input hCodeMeter RTS_IEC_HANDLE Handle to the open CodeMeter container which was retrieved by CodeMOpen() or CodeMGetFirst / CodeMGetNext.

CodeMDecrementUnitCounter (FUN) ¶ FUNCTION CodeMDecrementUnitCounter : RTS_IEC_RESULT Decrement the unit counter InOut: Scope Name Type Comment Return CodeMDecrementUnitCounter RTS_IEC_RESULT Error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded Input hCodeMeter RTS_IEC_HANDLE Handle to the CodeMeter license container retrieved by CodeMOpen(). udiUnitCount UDINT Unit count to decrement

CodeMDecrypt (FUN) ¶ FUNCTION CodeMDecrypt : RTS_IEC_RESULT Decrypt data InOut: Scope Name Type Comment Return CodeMDecrypt RTS_IEC_RESULT Error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded Input hCodeMeter RTS_IEC_HANDLE Handle to the CodeMeter license container retrieved by CodeMOpen(). udiEncryptionCode UDINT Encryption code ulCRC UDINT CRC of the encrypted data pbyData POINTER TO BYTE Pointer to data to decrypt nDataLen __XWORD Length of data to decrypt

CodeMEncrypt (FUN) ¶ FUNCTION CodeMEncrypt : RTS_IEC_RESULT Encrypt data InOut: Scope Name Type Comment Return CodeMEncrypt RTS_IEC_RESULT Error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded Input hCodeMeter RTS_IEC_HANDLE Handle to the CodeMeter license container retrieved by CodeMOpen(). udiEncryptionCode UDINT Encryption code pbyData POINTER TO BYTE Pointer to plain text data to encrypt nDataLen __XWORD Length of data to encrypt Inout ulCRC UDINT Returns CRC of the encrypted data

CodeMGetContentByFirmcode (FUN) ¶ FUNCTION CodeMGetContentByFirmcode : RTS_IEC_RESULT Get the license entry stored on a CodeMeter container with the specified identifiers InOut: Scope Name Type Comment Return CodeMGetContentByFirmcode RTS_IEC_RESULT Returns error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded Input duiFirmcode UDINT FirmCode of the license duiProductcode UDINT ProductCode of the license Inout licenseEntry RTS_CMBOXENTRY Returns the content of the license entry

CodeMGetContentByFirmcode2 (FUN) ¶ FUNCTION CodeMGetContentByFirmcode2 : RTS_IEC_RESULT Get the license entry stored on a CodeMeter container with the specified identifiers with the possibility to occupy a license. InOut: Scope Name Type Comment Return CodeMGetContentByFirmcode2 RTS_IEC_RESULT Returns error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded Input duiFirmcode UDINT FirmCode of the license duiProductcode UDINT ProductCode of the license bReleaseLicense BOOL TRUE: Release license so it can be used several from several instances FALSE: Don’t release license so it remains occupied and cannot be used by another instance Inout licenseEntry RTS_CMBOXENTRY Returns the content of the license entry

CodeMGetExpirationTime (FUN) ¶ FUNCTION CodeMGetExpirationTime : RTS_IEC_RESULT Get expiration time of an opened license InOut: Scope Name Type Comment Return CodeMGetExpirationTime RTS_IEC_RESULT Error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded Input hCodeMeter RTS_IEC_HANDLE Handle to the CodeMeter license container retrieved by CodeMOpen(). Inout dtExpiration DT Expiration time of the license

CodeMGetFirst (FUN) ¶ FUNCTION CodeMGetFirst : RTS_IEC_HANDLE Open the first CodeMeter license container InOut: Scope Name Type Comment Return CodeMGetFirst RTS_IEC_HANDLE Handle to the CodeMeter container or RTS_INVALID_HANDLE if not available! Inout Result RTS_IEC_RESULT Returns error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded

CodeMGetInfo (FUN) ¶ FUNCTION CodeMGetInfo : RTS_IEC_RESULT Get information of the opened CodeMeter device InOut: Scope Name Type Comment Return CodeMGetInfo RTS_IEC_RESULT Error code (see CmpErrors2 Interfaces Library) or ERR_OK if succeeded Input hCodeMeter RTS_IEC_HANDLE Handle to the CodeMeter license container retrieved by CodeMOpen() or CodeMGetFirst / CodeMGetNext. Inout info RTS_CODEMETER_INFO Returns information about the specified CodeMeter license container