documentation.HELP! GameShield v5 SDK Documentation

bea0f7a0c3a96f3111625b6fec4ef2792dff707e2e06e580fa661dad070b7787.chm

GameShield v5 SDK

Table of contents

• GameShield v5 SDK Programing Guide
  • Introduction
    • Features
    • Workflow
    • Software Stack
    • Differences between GameShield v5 and old versions
  • Concepts
    • Product Name
    • Product ID
    • Build Id
    • Entity
    • License
      • LicenseStatus
    • Action
      • License-Specific Action
      • What to Do Action String
    • Request Code
    • License Code (aka.
    • Variables and Parameters
  • Events
    • Application Events
    • License Events
    • Entity Events
  • Built-in Actions
    • act_unlock (1)
    • act_lock (2)
    • act_EnableCopyProtection (6)
    • act_disableCopyProtection (7)
    • act_resetAllExpiration (10)
    • act_clean (11)
    • act_fpFix (19)
  • Built-In License Models
    • Expire by Access Times
    • Expire by Hard Date
    • Expire by Period
    • Expire by Duration
    • Expire by Session Time
    • Always Run
    • Always Lock
  • FingerPrint
  • Execution Mode
    • P1: One Process Single Pass
    • P1S2: One Process Two Passes
    • P1S3: One Process Three Passes
    • P2: Dual Process
    • Game Launch Express Mode
  • SDK API Summary
  • Dynamic License Model
    • Parameter Accessibility
  • Programming Tutorial
    • Example 1: SDK Usage, License Status Checking
    • Example 2: License Reflection
    • Example 3: Request Code Composition
    • Example 4: License Code Apply
• Namespaces
  • Namespace List
    • gs
  • Namespace Members
    • All
    • Functions
    • Typedefs
    • Enumerations
    • Enumerator
• Classes
  • Class List
    • gs
      • TGSObject
        • handle
      • TGSVariable
        • asBool
        • asDouble
        • asFloat
        • asInt
        • asInt64
        • asString
        • asUTCTime
        • attribute
        • fromBool
        • fromDouble
        • fromFloat
        • fromInt
        • fromInt64
        • fromString
        • fromUTCTime
        • get
        • get
        • get
        • get
        • get
        • get
        • get
        • get
        • name
        • set
        • set
        • set
        • set
        • set
        • set
        • set
        • set
        • set
        • typeId
      • TGSAction
        • description
        • getParamByIndex
        • getParamByName
        • id
        • name
        • paramCount
        • whatToDo
      • TGSLicense
        • TGSLicense
        • actionCount
        • actionIds
        • actionNames
        • bindToEntity
        • description
        • getParamBool
        • getParamByIndex
        • getParamByName
        • getParamDouble
        • getParamFloat
        • getParamInt
        • getParamInt64
        • getParamStr
        • getParamUTCTime
        • getUnlockRequestCode
        • id
        • isValid
        • licensedEntity
        • name
        • paramCount
        • params
        • params
        • setParamBool
        • setParamDouble
        • setParamFloat
        • setParamInt
        • setParamInt64
        • setParamStr
        • setParamUTCTime
        • status
      • TGSRequest
        • addAction
        • addAction
        • addAction
        • addAction
        • code
      • TGSEntity
        • attribute
        • beginAccess
        • description
        • endAccess
        • getLicenseById
        • getLicenseByIndex
        • getUnlockRequestCode
        • id
        • isAccessible
        • isAccessing
        • isLocked
        • isUnlocked
        • licenseCount
        • licensePolicy
        • name
      • TGSCore
        • addVariable
        • applyLicenseCode
        • buildId
        • cleanUp
        • createRequest
        • flush
        • getCleanRequestCode
        • getDummyRequestCode
        • getEntityById
        • getEntityByIndex
        • getTotalEntities
        • getTotalVariables
        • getUnlockRequestCode
        • getVariableByIndex
        • getVariableByName
        • init
        • isInternalTimerActive
        • isTimeEngineActive
        • lastErrorCode
        • lastErrorMessage
        • loadFromLicenseFile
        • loadFromLocalStorage
        • pauseTimeEngine
        • productId
        • productName
        • removeVariable
        • resumeTimeEngine
        • revoke
        • tickFromExternalTimer
        • trace
        • turnOffInternalTimer
        • turnOnInternalTimer
      • TLM_Inspector
      • TLM_Period
      • TGSApp
        • TGSApp
        • core
        • exitApp
        • getAppCommandLine
        • getAppMainExe
        • getAppRootPath
        • getGameTitle
        • getSessionVar
        • isFirstGameExe
        • isFirstPass
        • isGamePass
        • isLastGameExe
        • isLastPass
        • isMainThread
        • isRestartedApp
        • OnAppBegin
        • OnAppEnd
        • OnAppEvent
        • OnAppInit
        • OnAppRun
        • OnClockRolledBack
        • OnEntityAccessEnded
        • OnEntityAccessEnding
        • OnEntityAccessInvalid
        • OnEntityAccessStarted
        • OnEntityAccessStarting
        • OnEntityActionApplied
        • OnEntityEvent
        • OnEntityHeartBeat
        • OnIntegrityCorrupted
        • OnLicenseEvent
        • OnLicenseFail
        • OnLicenseLoaded
        • OnLicenseLoading
        • OnNewInstall
        • OnUserEvent
        • pauseApp
        • playApp
        • restartApp
        • resumeAndExitApp
        • sendUserEvent
        • setSessionVar
        • terminateApp
      • TGSDynamicLM
        • TGSDynamicLM
        • ~TGSDynamicLM
        • defineParamBool
        • defineParamDouble
        • defineParamFloat
        • defineParamInt
        • defineParamInt64
        • defineParamStr
        • defineParamTime
        • finishAccess
        • init
        • isValid
        • license
        • onAction
        • startAccess
  • Class Index
  • Class Hierarchy
    • gs::TGSApp
    • gs::TGSCore
    • gs::TGSDynamicLM
    • gs::TGSObject
      • gs::TGSAction
      • gs::TGSEntity
      • gs::TGSLicense
      • gs::TGSRequest
      • gs::TGSVariable
    • gs::TLM_Inspector
      • gs::TLM_Period
  • Class Members
    • All
    • Functions
• Files
  • File List
    • GS5.h
      • TGSObject
        • handle
      • TGSVariable
        • asBool
        • asDouble
        • asFloat
        • asInt
        • asInt64
        • asString
        • asUTCTime
        • attribute
        • fromBool
        • fromDouble
        • fromFloat
        • fromInt
        • fromInt64
        • fromString
        • fromUTCTime
        • get
        • get
        • get
        • get
        • get
        • get
        • get
        • get
        • name
        • set
        • set
        • set
        • set
        • set
        • set
        • set
        • set
        • set
        • typeId
      • TGSAction
        • description
        • getParamByIndex
        • getParamByName
        • id
        • name
        • paramCount
        • whatToDo
      • TGSLicense
        • TGSLicense
        • actionCount
        • actionIds
        • actionNames
        • bindToEntity
        • description
        • getParamBool
        • getParamByIndex
        • getParamByName
        • getParamDouble
        • getParamFloat
        • getParamInt
        • getParamInt64
        • getParamStr
        • getParamUTCTime
        • getUnlockRequestCode
        • id
        • isValid
        • licensedEntity
        • name
        • paramCount
        • params
        • params
        • setParamBool
        • setParamDouble
        • setParamFloat
        • setParamInt
        • setParamInt64
        • setParamStr
        • setParamUTCTime
        • status
      • TGSRequest
        • addAction
        • addAction
        • addAction
        • addAction
        • code
      • TGSEntity
        • attribute
        • beginAccess
        • description
        • endAccess
        • getLicenseById
        • getLicenseByIndex
        • getUnlockRequestCode
        • id
        • isAccessible
        • isAccessing
        • isLocked
        • isUnlocked
        • licenseCount
        • licensePolicy
        • name
      • TGSCore
        • addVariable
        • applyLicenseCode
        • buildId
        • cleanUp
        • createRequest
        • flush
        • getCleanRequestCode
        • getDummyRequestCode
        • getEntityById
        • getEntityByIndex
        • getTotalEntities
        • getTotalVariables
        • getUnlockRequestCode
        • getVariableByIndex
        • getVariableByName
        • init
        • isInternalTimerActive
        • isTimeEngineActive
        • lastErrorCode
        • lastErrorMessage
        • loadFromLicenseFile
        • loadFromLocalStorage
        • pauseTimeEngine
        • productId
        • productName
        • removeVariable
        • resumeTimeEngine
        • revoke
        • tickFromExternalTimer
        • trace
        • turnOffInternalTimer
        • turnOnInternalTimer
      • TLM_Inspector
      • TLM_Period
      • GS_ERROR_GENERIC
      • GS_ERROR_INVALID_HANDLE
      • GS_ERROR_INVALID_INDEX
      • GS_ERROR_INVALID_NAME
      • GS_ERROR_INVALID_ACTION
      • GS_ERROR_INVALID_LICENSE
      • GS_ERROR_INVALID_ENTITY
      • GS_ERROR_INVALID_VALUE
      • TGSVariable::get< std::string >
      • TGSVariable::set< std::string >
    • GS5_Ext.h
      • TGSApp
        • TGSApp
        • core
        • exitApp
        • getAppCommandLine
        • getAppMainExe
        • getAppRootPath
        • getGameTitle
        • getSessionVar
        • isFirstGameExe
        • isFirstPass
        • isGamePass
        • isLastGameExe
        • isLastPass
        • isMainThread
        • isRestartedApp
        • OnAppBegin
        • OnAppEnd
        • OnAppEvent
        • OnAppInit
        • OnAppRun
        • OnClockRolledBack
        • OnEntityAccessEnded
        • OnEntityAccessEnding
        • OnEntityAccessInvalid
        • OnEntityAccessStarted
        • OnEntityAccessStarting
        • OnEntityActionApplied
        • OnEntityEvent
        • OnEntityHeartBeat
        • OnIntegrityCorrupted
        • OnLicenseEvent
        • OnLicenseFail
        • OnLicenseLoaded
        • OnLicenseLoading
        • OnNewInstall
        • OnUserEvent
        • pauseApp
        • playApp
        • restartApp
        • resumeAndExitApp
        • sendUserEvent
        • setSessionVar
        • terminateApp
      • TGSDynamicLM
        • TGSDynamicLM
        • ~TGSDynamicLM
        • defineParamBool
        • defineParamDouble
        • defineParamFloat
        • defineParamInt
        • defineParamInt64
        • defineParamStr
        • defineParamTime
        • finishAccess
        • init
        • isValid
        • license
        • onAction
        • startAccess
      • DECLARE_APP
      • DECLARE_LM
      • GET_APP
      • IMPLEMENT_APP
      • IMPLEMENT_LM
    • GS5_Intf.h
      • ACT_ADD_ACCESSTIME
      • ACT_ADD_EXPIRE_DURATION
      • ACT_ADD_EXPIRE_PERIOD
      • ACT_CLEAN
      • ACT_DISABLE_COPYPROTECTION
      • ACT_DUMMY
      • ACT_ENABLE_COPYPROTECTION
      • ACT_FP_FIX
      • ACT_LOCK
      • ACT_NAG_OFF
      • ACT_NAG_ON
      • ACT_ONE_SHOT
      • ACT_REVOKE
      • ACT_SET_ACCESSTIME
      • ACT_SET_ENDDATE
      • ACT_SET_EXPIRE_DURATION
      • ACT_SET_EXPIRE_PERIOD
      • ACT_SET_SESSIONTIME
      • ACT_SET_STARTDATE
      • ACT_SHELFTIME
      • ACT_UNLOCK
      • ENTITY_ATTRIBUTE_ACCESSIBLE
      • ENTITY_ATTRIBUTE_ACCESSING
      • ENTITY_ATTRIBUTE_AUTOSTART
      • ENTITY_ATTRIBUTE_LOCKED
      • ENTITY_ATTRIBUTE_UNLOCKED
      • EVENT_APP_BEGIN
      • EVENT_APP_CLOCK_ROLLBACK
      • EVENT_APP_END
      • EVENT_APP_INTEGRITY_CORRUPT
      • EVENT_APP_RUN
      • EVENT_ENTITY_ACCESS_ENDED
      • EVENT_ENTITY_ACCESS_ENDING
      • EVENT_ENTITY_ACCESS_HEARTBEAT
      • EVENT_ENTITY_ACCESS_INVALID
      • EVENT_ENTITY_ACCESS_STARTED
      • EVENT_ENTITY_ACTION_APPLIED
      • EVENT_ENTITY_TRY_ACCESS
      • EVENT_IDBASE_APPLICATION
      • EVENT_IDBASE_ENTITY
      • EVENT_IDBASE_LICENSE
      • EVENT_LICENSE_FAIL
      • EVENT_LICENSE_LOADING
      • EVENT_LICENSE_NEWINSTALL
      • EVENT_LICENSE_READY
      • GS_USER_EVENT
      • INVALID_GS_HANDLE
      • LM_PARAM_HIDDEN
      • LM_PARAM_INHERIT
      • LM_PARAM_READ
      • LM_PARAM_TEMP
      • LM_PARAM_WRITE
      • VAR_ATTR_HIDDEN
      • VAR_ATTR_PERSISTENT
      • VAR_ATTR_READ
      • VAR_ATTR_REMOTE
      • VAR_ATTR_SECURE
      • VAR_ATTR_SYSTEM
      • VAR_ATTR_WRITE
      • VM_Fusion
      • VM_Parallel
      • VM_QEMU
      • VM_VirtualBox
      • VM_VirtualPC
      • VM_VMware
      • action_id_t
      • entity_id_t
      • gs_handle_t
      • license_id_t
      • TActionHandle
      • TEntityHandle
      • TEventHandle
      • TEventSourceHandle
      • TLicenseHandle
      • TMonitorHandle
      • TRequestHandle
      • TVarHandle
      • var_type_t
      • vm_mask_t
      • TEventType
        • EVENT_TYPE_APP
        • EVENT_TYPE_LICENSE
        • EVENT_TYPE_ENTITY
        • EVENT_TYPE_USER
      • TLicensePolicy
        • POLICY_INVALID
        • POLICY_ANY
        • POLICY_ALL
      • TLicenseStatus
        • STATUS_INVALID
        • STATUS_LOCKED
        • STATUS_UNLOCKED
        • STATUS_ACTIVE
      • TVarType
        • VAR_TYPE_INT
        • VAR_TYPE_INT64
        • VAR_TYPE_FLOAT
        • VAR_TYPE_DOUBLE
        • VAR_TYPE_BOOL
        • VAR_TYPE_STRING
        • VAR_TYPE_TIME
      • gsAddRequestAction
      • gsAddRequestActionEx
      • gsAddVariable
      • gsApplyLicenseCode
      • gsBeginAccessEntity
      • gsCleanUp
      • gsCloseHandle
      • gsCreateRequest
      • gsEndAccessEntity
      • gsExitApp
      • gsFlush
      • gsGetActionDescription
      • gsGetActionId
      • gsGetActionInfoByIndex
      • gsGetActionInfoCount
      • gsGetActionName
      • gsGetActionParamByIndex
      • gsGetActionParamByName
      • gsGetActionParamCount
      • gsGetActionString
      • gsGetAppCommandLine
      • gsGetAppMainExe
      • gsGetAppRootPath
      • gsGetAppVar
      • gsGetBuildId
      • gsGetEntityAttributes
      • gsGetEntityCount
      • gsGetEntityDescription
      • gsGetEntityId
      • gsGetEntityLicensePolicy
      • gsGetEntityName
      • gsGetLastErrorCode
      • gsGetLastErrorMessage
      • gsGetLicenseCount
      • gsGetLicensedEntity
      • gsGetLicenseDescription
      • gsGetLicenseId
      • gsGetLicenseName
      • gsGetLicenseParamByIndex
      • gsGetLicenseParamByName
      • gsGetLicenseParamCount
      • gsGetLicenseStatus
      • gsGetProductId
      • gsGetProductName
      • gsGetRequestCode
      • gsGetTotalVariables
      • gsGetUserEventData
      • gsGetVariable
      • gsGetVariableAttr
      • gsGetVariableByIndex
      • gsGetVariableName
      • gsGetVariableType
      • gsGetVariableValueAsDouble
      • gsGetVariableValueAsFloat
      • gsGetVariableValueAsInt
      • gsGetVariableValueAsInt64
      • gsGetVariableValueAsString
      • gsGetVariableValueAsTime
      • gsGetVersion
      • gsInit
      • gsIsDebugVersion
      • gsIsLicenseValid
      • gsIsNodeLocked
      • gsIsRestartedApp
      • gsIsVariableValid
      • gsLoadFromLicenseFile
      • gsLoadFromLocalStorage
      • gsOpenEntityById
      • gsOpenEntityByIndex
      • gsOpenLicenseById
      • gsOpenLicenseByIndex
      • gsPauseApp
      • gsPlayApp
      • gsPostUserEvent
      • gsRemoveVariable
      • gsRenderHTML
      • gsRenderHTMLEx
      • gsRestartApp
      • gsResumeAndExitApp
      • gsRevoke
      • gsRunInsideVM
      • gsRunInWrappedMode
      • gsSetAppVar
      • gsSetVariableValueFromDouble
      • gsSetVariableValueFromFloat
      • gsSetVariableValueFromInt
      • gsSetVariableValueFromInt64
      • gsSetVariableValueFromString
      • gsSetVariableValueFromTime
      • gsTerminateApp
      • gsTrace
      • gsVariableAttrFromString
      • gsVariableAttrToString
      • gsVariableTypeToString
  • File Members
    • All
    • Macros

next page

Get in touch

Submit feedback about this site to:

• [email protected]