方法摘要

函数名	介绍
Bit_Login	授权登录。初始化运行环境，获取操作句柄。必须在除升级函数之外的其它操作前执行。根据登录模式的不同可能需要连接授权服务器。
Bit_LoginEx	授权登录的增强版本。允许应用程序在登录时指定授权中所需包含的特征项，以缩小登录范围。
Bit_Logout	此函数用于释放上下文句柄，退出登录状态。
Bit_ReadFeature	此函数用于读取特征项的数据内容，可用于“只读”和“读写”特征类型。
Bit_WriteFeature	此函数用于更新“读写”类型的特征项的数据内容。
Bit_ConvertFeature	此函数用于使用“算法”类型的特征项对输入参数进行变换操作，得到唯一对应的4字节结果。
Bit_EncryptFeature	此函数用于使用“密钥”类型的特征项对输入的明文进行加密，返回密文结果。
Bit_DecryptFeature	此函数用于使用“密钥”类型的特征项对输入的密文进行解密，返回明文结果。
Bit_QueryFeature	请求特征项，检查特征项是否存在并可用。可用于任意特征项类型。对于集团授权，函数执行成功后会占用一个模块用户数。
Bit_QueryFeatureEx	集团授权，通过featureId和version来占用特征项的用户数。
Bit_QueryFeatureEx2	集团授权，通过featureName和version来占用特征项的用户数。
Bit_ReleaseFeature	释放特征项。集团授权会释放模块用户数。
Bit_ReleaseFeatureEx	集团授权，释放指定版本的特征项下的用户数。
Bit_ReleaseFeatureEx2	集团授权，释放指定ticket下的特征项的所有用户数。
Bit_SetDataItem	创建或更新配置项。如果相同名称的配置项存在，则会更新其中的数据；否则将添加新的授权码配置项。
Bit_RemoveDataItem	删除指定的配置项。该操作无法删除通过控制台设置的产品配置项或模版配置项。
Bit_GetDataItem	读取指定的配置项数据。
Bit_GetDataItemNum	此函数用于获取可访问配置项的数量，一般用于配置项的枚举操作。
Bit_GetDataItemName	根据配置项索引获取其名称，一般用于配置项的枚举操作。
Bit_GetSessionInfo	获取当前会话信息，以字符串形式返回。根据获取的内容不同，返回结果可能是XML格式或非XML格式。返回数据中的日期项已根据客户端的本地时区进行调整。如果Login时未指定SN，返回串为当前系统所有可用SN的综合结果。
Bit_GetFeatureInfo	获取指定特征项的信息。
Bit_GetRequestInfo	获取当前运行环境的升级请求码，用于发起本地授权激活及升级请求。
Bit_GetUpdateInfo	使用请求码与授权服务器进行连接，获取升级码。本函数需要进行网络连接。
Bit_ApplyUpdateInfo	应用升级码完成本地授权激活或升级。本函数必须在获取请求码的同一环境下执行。
Bit_UpdateOnline	此函数用于与授权服务器在线连接，自动完成本地授权的升级操作。本函数需要进行网络连接。
Bit_Revoke	从客户端迁出已激活的浮动授权码。授权码迁出后，可以用于其它的客户端。根据输入参数的不同，本函数可用于在线或离线迁出。
Bit_CheckOutSn	从集团授权服务器借出一个完整的授权码，以允许客户端脱离集团服务器单独使用。被借出的集团授权码必须具有可借出属性，并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给集团服务器。
Bit_CheckOutSnEx	从授权服务器借出一个完整的授权码，以允许客户端服务器单独使用。被借出的授权码必须具有可借出属性，并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给服务器。
Bit_CheckOutFeatures	从集团授权服务器借出一组特征项，这些特征项必须包含在同一个授权码中。被借出的集团授权码必须具有可借出属性，并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给集团服务器。
Bit_CheckIn	提前返还从集团授权服务器借出的授权。要提前返还授权，该授权码必须具有允许提前返还属性。
Bit_CheckInEx	提前返还从授权服务器借出的授权。要提前返还授权，该授权码必须具有允许提前返还属性。
Bit_GetInfo	获取授权信息及使用环境信息，数据以XML格式返回。调用此函数前客户端不需要执行登录操作。
Bit_RemoveSn	删除指定授权码在本机的授权数据，可用于测试或当授权数据出现问题而不能通过升级解决时的故障处理。
Bit_SetCustomInfo	设置客户端运行自定义信息，需要在可能使用自定义信息的API（如Login）前调用。
Bit_GetVersion	获取客户端安全库版本号。
Bit_GetTicketInfo	查看指定ticket的相关信息。
Bit_SetAttr	设置回调函数、阻塞队列超时时间、心跳重试次数、心跳重试间隔等。
Bit_GetFeatureInfo2	检查特征项是否存在，不会占用授权码或特征项的用户数，获取特征项的剩余有效期。
Bit_GetFeatureInfoEx2	获取指定feature的信息，以XML格式返回。
Bit_SetSessionState	设置客户端的状态为空闲状态或繁忙状态或激活状态。
Bit_SetLocalServer	设置集团服务的地址和端口。
Bit_TestBitService	测试集团授权的特征项是否可用，不会占用授权码或特征项的用户数。
Bit_SetRootPath	设置授权文件的存储路径。
Bit_GetProductPath	获取授权存储目录。
Bit_SetProxy	设置代理服务的地址和端口。

方法详细信息

Bit_Login

    BIT_STATUS Bit_Login (
                 BIT_PCSTR szURL,
                 BIT_PCSTR szSN,
                 BIT_UCHAR * pApplicationData,
                 BIT_HANDLE * pHandle,
                 LOGIN_MODE mode)

授权登录。初始化运行环境，获取操作句柄。必须在除升级函数之外的其它操作前执行。根据登录模式的不同可能需要连接授权服务器。

参数

szURL - [IN] 自定义授权服务器地址，包括端口。如未使用自定义授权服务器则为NULL。
szSN - [IN] 授权码（SN）字符串。如果为空（空串或NULL）则尝试寻找所有当前本机可用的SN
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
pHandle - [OUT] 通过Login函数返回的上下文句柄。
mode - [IN] 登录模式。

mode 类型

BIT_MODE_LOCAL - 登录本地授权，不会尝试寻找集团或云授权服务器。如果本地授权失效也不会尝试自动升级
BIT_MODE_REMOTE - 登录远程授权服务器，尝试建立云授权或集团授权连接，服务器地址由URL参数或配置文件提供
BIT_MODE_AUTO - 同时尝试本地授权及远程授权，寻找任何可用的授权方式。可能自动升级失效的本地授权

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_LoginEx

    BIT_STATUS Bit_LoginEx (
                 BIT_PCSTR szURL,
                 BIT_PCSTR szSN,
                 BIT_UINT32 featureId,
                 BIT_PCSTR xmlScope,
                 BIT_UCHAR * pApplicationData,
                 BIT_HANDLE * pHandle,
                 LOGIN_MODE mode)

授权登录的增强版本。允许应用程序在登录时指定授权中所需包含的特征项，以缩小登录范围。

参数

szURL - [IN] 自定义授权服务器地址，包括端口。如未使用自定义授权服务器则为NULL。
szSN - [IN] 授权码（SN）字符串。如果为空（空串或NULL）则尝试寻找所有当前本机可用的SN
featureId - [IN] 登录授权所需要包含的特征项ID
xmlScope - [IN] 登录范围。用于提供更多的登录条件，格式为标准XML字符串。目前保留，必须为NULL
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
pHandle - [OUT] 通过Login函数返回的上下文句柄。
mode - [IN] 登录模式。

mode 类型

BIT_MODE_LOCAL - 登录本地授权，不会尝试寻找集团或云授权服务器。如果本地授权失效也不会尝试自动升级
BIT_MODE_REMOTE - 登录远程授权服务器，尝试建立云授权或集团授权连接，服务器地址由URL参数或配置文件提供
BIT_MODE_AUTO - 同时尝试本地授权及远程授权，寻找任何可用的授权方式。可能自动升级失效的本地授权

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_Logout

    BIT_STATUS Bit_Logout (
                 BIT_HANDLE handle)

此函数用于释放上下文句柄，退出登录状态。

参数

handle - [IN] 通过Login函数返回的上下文句柄。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_ReadFeature

    BIT_STATUS Bit_ReadFeature (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_UINT32 * pFeatureValue)

此函数用于读取特征项的数据内容，可用于“只读”和“读写”特征类型。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
pFeatureValue - [OUT] 特征项数据缓存区地址，用于存储读出的数据。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_WriteFeature

    BIT_STATUS Bit_WriteFeature (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_UINT32 featureValue)

此函数用于更新“读写”类型的特征项的数据内容。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
featureValue - [IN] 特征项数据值。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_ConvertFeature

    BIT_STATUS Bit_ConvertFeature (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_UINT32 para1,
                 BIT_UINT32 para2,
                 BIT_UINT32 para3,
                 BIT_UINT32 para4,
                 BIT_UINT32 * pResult)

此函数用于使用“算法”类型的特征项对输入参数进行变换操作，得到唯一对应的4字节结果。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
para1 - [IN] 变换输入因子1
para2 - [IN] 变换输入因子2
para3 - [IN] 变换输入因子3
para4 - [IN] 变换输入因子4
pResult - [OUT] 变换结果。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_EncryptFeature

    BIT_STATUS Bit_EncryptFeature (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_VOID * pPlainBuffer,
                 BIT_VOID * pCipherBuffer,
                 BIT_UINT32 dataBufferSize)

此函数用于使用“密钥”类型的特征项对输入的明文进行加密，返回密文结果。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
pPlainBuffer - [IN] 数据缓存区地址，用于存储明文数据。
pCipherBuffer - [OUT] 数据缓存区地址，用于存储密文数据。
dataBufferSize - [IN] 数据长度，最大长度为256字节。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_DecryptFeature

    BIT_STATUS Bit_DecryptFeature (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_VOID * pCipherBuffer,
                 BIT_VOID * pPlainBuffer,
                 BIT_UINT32 dataBufferSize)

此函数用于使用“密钥”类型的特征项对输入的密文进行解密，返回明文结果。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
pCipherBuffer - [IN] 数据缓存区地址，用于存储密文数据。
pPlainBuffer - [OUT] 数据缓存区地址，用于存储明文数据。
dataBufferSize - [IN] 数据长度，最大长度为256字节。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_QueryFeature

    BIT_STATUS Bit_QueryFeature (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_UINT32 * pCapacity)

请求特征项，检查特征项是否存在并可用。可用于任意特征项类型。对于集团授权，函数执行成功后会占用一个模块用户数。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
pCapacity - [OUT] 当不为NULL时，获取特征项当前可用用户数。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_QueryFeatureEx

    BIT_STATUS Bit_QueryFeatureEx (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_UINT32 mode,
                 BIT_UINT32 required,
                 BIT_UINT32 * pCapacity,
                 BIT_PCSTR xmlScope)

集团授权，通过featureId和version来占用特征项的用户数。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
mode - [IN] QueryEx的登录模式。
required - [IN] 表示需要占用的总用户数，总用户数包括当前设备已经占用的用户数，如果传入的数量大于当前特征项的最大用户数，则占用全部用户数。
pCapacity - [OUT] 特征项数据缓存区地址，用于存储读出的数据，根据mode参数的不同返回剩余用户数或者已占用户数。
xmlScope - [IN] 特征项支持小数版本，可以通过xml格式传入版本，也可以直接传入版本的字符串。

mode 类型

BIT_QUERY_DEFAULT - 非阻塞登录，占用required个用户数，如果用户数不够将返回错误，pCapacity 保存剩余用户数。
BIT_QUERY_AVAILABLE - 尽可能的占用 required（不能为 0）个用户数，如果用户数不够将占用剩余的用户数，pCapacity 保存当前申请到的用户数。
BIT_QUERY_CHECK - pCapacity 返回总共占用的用户数,required 必须为 0。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_QueryFeatureEx2

    BIT_STATUS Bit_QueryFeatureEx2 (
                 BIT_HANDLE handle,
                 BIT_PCSTR featureName,
                 BIT_UINT32 mode,
                 BIT_UINT32 required,
                 BIT_PCSTR xmlScope,
                 BIT_TICKET * pTicket)

集团授权，通过featureName和version来占用特征项的用户数。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureName - [IN] 产品的特征项名称。
mode - [IN] QueryEx2的登录模式。
required - [IN] 表示需要占用的用户数,多次调用可累加占用用户数。
xmlScope - [IN] 特征项支持小数版本，可以通过 xml 格式传入版本，也可以直接传入版本的字符串。
pTicket - [IN/OUT] 输入时指针变量的值必须为0，输出时为当前Query请求的句柄。

mode 类型

BIT_QUERY_DEFAULT - 非阻塞登录，占用required个用户数，如果用户数不够将返回错误。
BIT_QUERY_AVAILABLE - 尽可能的占用 required（不能为 0）个用户数，如果用户数不够将占用剩余的用户数。
BIT_QUERY_WAIT - 阻塞队列登录，如果用户数不够，将加入队列阻塞等待。
BIT_QUERY_QUEUE - 非阻塞队列登录，如果用户数不够，将加入队列，不会阻塞等待。
BIT_QUERY_TEST - 测试特征项版本是否可用，与DEFAULT、WAIT、QUEUE搭配使用。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_ReleaseFeature

    BIT_STATUS Bit_ReleaseFeature (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_UINT32 * pCapacity)

释放特征项。集团授权会释放模块用户数。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
pCapacity - [OUT] 当不为NULL时，获取特征项当前可用用户数。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_ReleaseFeatureEx

    BIT_STATUS Bit_ReleaseFeatureEx (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_UINT32 consumed,
                 BIT_UINT32 * pCapacity,
                 BIT_PCSTR xmlScope)

集团授权，释放指定版本的特征项下的用户数。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
consumed - [IN] 需要释放的用户数，传0代表释放所有用户数，如果传入的释放数大于当前登录的用户数则释放所有用户数。
pCapacity - [OUT] 特征项数据缓存区地址，用于存储读出的数据，返回已释放的用户数。
xmlScope - [IN] 特征项支持小数版本，可以通过xml格式传入版本，也可以直接传入版本的字符串。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_ReleaseFeatureEx2

    BIT_STATUS Bit_ReleaseFeatureEx2 (
                 BIT_TICKET ticket,
                 BIT_UINT32 consumed)

集团授权，释放指定ticket下的特征项的所有用户数。

参数

ticket - [IN] 通过QueryFeatureEx2函数返回的上下文句柄。
consumed - [IN] 需要释放的用户数，目前默认必须传0，代表释放所有用户数。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_SetDataItem

    BIT_STATUS Bit_SetDataItem (
                 BIT_HANDLE handle,
                 BIT_PCSTR szDataItemName,
                 BIT_VOID * pDataItemValue,
                 BIT_UINT32 dataItemValueSize)

创建或更新配置项。如果相同名称的配置项存在，则会更新其中的数据；否则将添加新的授权码配置项。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
szDataItemName - [IN] 数据项名称，名称最大长度为128字节。
pDataItemValue - [IN] 数据项数据缓存区地址，数据最大长度为1024字节。
dataItemValueSize - [IN] 数据项长度。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_RemoveDataItem

    BIT_STATUS Bit_RemoveDataItem (
                 BIT_HANDLE handle,
                 BIT_PCSTR szDataItemName)

删除指定的配置项。该操作无法删除通过控制台设置的产品配置项或模版配置项。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
szDataItemName - [IN] 数据项名称，名称最大长度为128字节。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetDataItem

    BIT_STATUS Bit_GetDataItem (
                 BIT_HANDLE handle,
                 BIT_PCSTR szDataItemName,
                 BIT_VOID * pDataItemValue,
                 BIT_UINT32 * pDataItemValueSize)

读取指定的配置项数据。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
szDataItemName - [IN] 数据项名称，名称最大长度为128字节。
pDataItemValue - [OUT] 数据项数据缓存区地址，数据最大长度为1024字节。
pDataItemValueSize - [IN/OUT] 数据项长度。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetDataItemNum

    BIT_STATUS Bit_GetDataItemNum (
                 BIT_HANDLE handle,
                 BIT_UINT32 * pNum)

此函数用于获取可访问配置项的数量，一般用于配置项的枚举操作。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
pNum - [OUT] 可访问的数据项总数，包括了所有可以访问到的产品、模版及授权码的数据项。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetDataItemName

    BIT_STATUS Bit_GetDataItemName (
                 BIT_HANDLE handle,
                 BIT_UINT32 index,
                 BIT_CHAR * pDataItemName,
                 BIT_UINT32 * pDataItemNameSize)

根据配置项索引获取其名称，一般用于配置项的枚举操作。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
index - [IN] 数据项索引。
pDataItemName - [OUT] 用于存储数据项名称的存储区地址。
pDataItemNameSize - [IN/OUT] 数据项名称存储区大小。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetSessionInfo

    BIT_STATUS Bit_GetSessionInfo (
                 BIT_HANDLE handle,
                 SESSION_TYPE type,
                 BIT_CHAR * pSessionInfo,
                 BIT_UINT32 * pSessionInfoSize)

获取当前会话信息，以字符串形式返回。根据获取的内容不同，返回结果可能是XML格式或非XML格式。返回数据中的日期项已根据客户端的本地时区进行调整。如果Login时未指定SN，返回串为当前系统所有可用SN的综合结果。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
type - [IN] 获取会话信息类型。
pSessionInfo - [OUT] 会话信息存储区地址。可以为NULL，此时仅用于获取存储区大小。
pSessionInfoSize - [IN/OUT] 会话存储区大小。

type 类型

XML_TYPE_SN_INFO - 获取当前会话中授权码的授权信息，以XML结构表示。未作限制的授权项将不会返回
XML_TYPE_FEATURE_INFO - 获取当前会话中授权码的特征项信息，以XML结构表示
XML_TYPE_DATA_INFO - 获取当前会话中授权码的配置项信息，以XML结构表示
BIT_SERVER_ADDRESS - 授权服务器IP地址。只对云授权有意义，其它授权方式将返回：127.0.0.1
BIT_SERVER_TIME - 授权服务器系统时间。如果是本地授权，将返回本机系统时间
BIT_CONTROL_TYPE - 授权类型。是以逗号分隔的以下几种类型的组合：Group（集团授权），Smart（智能连接）, Float（可浮动）, Demo（演示授权）, USB（U盘授权）, Force（强制认证）
BIT_VOLUME_NUMBER - 允许使用的机器数量
BIT_START_DATE - 授权开始日期
BIT_END_DATE - 授权结束日期
BIT_EXPIRATION_DAYS - 授权有效期，单位为天。有效期从激活时间算起
BIT_USAGE_NUMBER - 最大使用次数
BIT_CONSUMED_USAGE_NUMBER - 对于设定最大使用次数的授权码，返回当前使用次数
BIT_ACTIVATE_DATE - 授权码激活时间
BIT_USER_LIMIT - 集团授权用户数。对其它方式的授权返回0
BIT_LAST_UPDATE_DATE - 最后与服务器连接时间
BIT_MAX_OFFLINE_MINUTES - 强制认证最大离线时间（分钟）

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetFeatureInfo

    BIT_STATUS Bit_GetFeatureInfo (
                 BIT_HANDLE handle,
                 BIT_UINT32 featureId,
                 BIT_FEATURE_INFO * pFeatureInfo)

获取指定特征项的信息。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureId - [IN] 产品的特征项ID。
pFeatureInfo - [OUT] 特征项信息。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetRequestInfo

    BIT_STATUS Bit_GetRequestInfo (
                 BIT_PCSTR szSN,
                 BIT_UCHAR * pApplicationData,
                 BINDING_TYPE type,
                 BIT_CHAR * pRequestInfo,
                 BIT_UINT32 * pRequestInfoSize)

获取当前运行环境的升级请求码，用于发起本地授权激活及升级请求。

参数

szSN - [IN] 授权码（SN）字符串。如果为空（空串或NULL）则尝试寻找所有当前本机可用的SN
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
type - [IN] 本地授权绑定类型。
pRequestInfo - [OUT] 用于存储请求码的存储区地址。
pRequestInfoSize - [IN/OUT] 输入时为请求码存储区大小，输出时为请求码长度。

type 类型

BINDING_EXISTING - 使用当前绑定类型，对已激活授权码进行升级时使用。
BINDING_LOCAL - 使用本机指纹进行绑定
BINDING_USB_STORAGE - 使用USB存储器进行绑定

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetUpdateInfo

    BIT_STATUS Bit_GetUpdateInfo (
                 BIT_PCSTR szURL,
                 BIT_PCSTR szSN,
                 BIT_UCHAR * pApplicationData,
                 BIT_PCSTR pRequestInfo,
                 BIT_CHAR * pUpdateInfo,
                 BIT_UINT32 * pUpdateInfoSize)

使用请求码与授权服务器进行连接，获取升级码。本函数需要进行网络连接。

参数

szURL - [IN] 自定义授权服务器地址，包括端口。如未使用自定义授权服务器则为NULL。
szSN - [IN] 授权码（SN）字符串
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
pRequestInfo - [IN] 由获取请求码函数得到的请求码。
pUpdateInfo - [OUT] 由授权服务器获得的本地授权升级码。
pUpdateInfoSize - [IN/OUT] 输入时为存储区大小，输出时为升级码长度。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_ApplyUpdateInfo

    BIT_STATUS Bit_ApplyUpdateInfo (
                 BIT_UCHAR * pApplicationData,
                 BIT_PCSTR pUpdateInfo,
                 BIT_CHAR * pReceiptInfo,
                 BIT_UINT32 * pReceiptInfoSize)

应用升级码完成本地授权激活或升级。本函数必须在获取请求码的同一环境下执行。

参数

pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
pUpdateInfo - [IN] 由授权服务器获得的本地授权升级码。
pReceiptInfo - [OUT] 确认码，记录升级状态，可在控制台上解析。
pReceiptInfoSize - [IN/OUT] 输入时为存储区大小，输出时为确认码长度。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_UpdateOnline

    BIT_STATUS Bit_UpdateOnline (
                 BIT_PCSTR szURL,
                 BIT_PCSTR szSN,
                 BIT_UCHAR * pApplicationData)

此函数用于与授权服务器在线连接，自动完成本地授权的升级操作。本函数需要进行网络连接。

参数

szURL - [IN] 自定义授权服务器地址，包括端口。如未使用自定义授权服务器则为NULL。
szSN - [IN] 授权码（SN）字符串。如果为空（空串或NULL）则尝试寻找所有当前本机可用的SN
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_Revoke

    BIT_STATUS Bit_Revoke (
                 BIT_PCSTR szURL,
                 BIT_PCSTR szSN,
                 BIT_UCHAR * pApplicationData,
                 BIT_CHAR * pRevocationInfo,
                 BIT_UINT32 * pRevocationInfoSize)

从客户端迁出已激活的浮动授权码。授权码迁出后，可以用于其它的客户端。根据输入参数的不同，本函数可用于在线或离线迁出。

参数

szURL - [IN] 自定义授权服务器地址，包括端口。如未使用自定义授权服务器则为NULL。
szSN - [IN] 授权码（SN）字符串
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
pRevocationInfo - [OUT] 迁出请求码的存储区地址。为NULL表示进行在线迁出，否则API将执行手工离线迁出，请求码应发给服务器进行确认。
pRevocationInfoSize - [IN/OUT] 输入时为请求码存储区大小，输出时为请求码长度。如此参数为NULL，函数将选择在线迁出。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_CheckOutSn

    BIT_STATUS Bit_CheckOutSn (
                 BIT_PCSTR szURL,
                 BIT_UINT32 featureId,
                 BIT_UCHAR * pApplicationData,
                 BIT_UINT32 nDurationDays)

从集团授权服务器借出一个完整的授权码，以允许客户端脱离集团服务器单独使用。被借出的集团授权码必须具有可借出属性，并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给集团服务器。

参数

szURL - [IN] 集团授权服务器地址，包括端口。如输入NULL，则使用配置文件地址；如输入 * 号，则使用广播查找地址。
featureId - [IN] 指定借出授权码需要包含的特征项ID，为 0 则寻找第一个可借出授权码。
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
nDurationDays - [IN] 借出时间，单位为天。借出时间不能超过被借出集团授权的强制认证周期或有效期。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_CheckOutSnEx

    BIT_STATUS Bit_CheckOutSnEx (
                 BIT_PCSTR szURL,
                 BIT_UINT32 featureId,
                 BIT_PCSTR xmlScope,
                 BIT_UCHAR * pApplicationData,
                 BIT_UINT32 nDurationDays)

从授权服务器借出一个完整的授权码，以允许客户端服务器单独使用。被借出的授权码必须具有可借出属性，并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给服务器。

参数

szURL - [IN] 集团授权服务器地址，包括端口。如输入NULL，则使用配置文件地址；如输入 * 号，则使用广播查找地址。
featureId - [IN] 指定借出授权码需要包含的特征项ID，为 0 则寻找第一个可借出授权码。
xmlScope - [IN] 用于指定借出的参数，格式：wsxxxx，type设定为ws时表示从云授权服务器借出和归还。
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
nDurationDays - [IN] 借出时间，单位为天。借出时间不能超过被借出集团授权的强制认证周期或有效期。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_CheckOutFeatures

    BIT_STATUS Bit_CheckOutFeatures (
                 BIT_PCSTR szURL,
                 BIT_UCHAR * pApplicationData,
                 BIT_UINT32 * pFeatureList,
                 BIT_UINT32 nFeatureInList,
                 BIT_UINT32 nDurationDays)

从集团授权服务器借出一组特征项，这些特征项必须包含在同一个授权码中。被借出的集团授权码必须具有可借出属性，并在客户端成功借出后减少一个可用用户数。被借出的用户数在到期后将自动返还给集团服务器。

参数

szURL - [IN] 集团授权服务器地址，包括端口。如输入NULL，则使用配置文件地址；如输入 * 号，则使用广播查找地址。
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
pFeatureList - [IN] 要借出的特征项列表。
nFeatureInList - [IN] 要借出的特征项数量。
nDurationDays - [IN] 借出时间，单位为天。借出时间不能超过被借出集团授权的强制认证周期或有效期。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_CheckIn

    BIT_STATUS Bit_CheckIn (
                 BIT_PCSTR szURL,
                 BIT_UINT32 featureId,
                 BIT_UCHAR * pApplicationData)

提前返还从集团授权服务器借出的授权。要提前返还授权，该授权码必须具有允许提前返还属性。

参数

szURL - [IN] 集团授权服务器地址，包括端口。如输入NULL，则使用配置文件地址；如输入 * 号，则使用广播查找地址。
featureId - [IN] 指定要返还授权码需要包含的特征项ID，为 0 则寻找第一个可返还授权码。
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_CheckInEx

    BIT_STATUS Bit_CheckInEx (
                 BIT_PCSTR szURL,
                 BIT_UINT32 featureId,
                 BIT_PCSTR xmlScope,
                 BIT_UCHAR * pApplicationData)

提前返还从授权服务器借出的授权。要提前返还授权，该授权码必须具有允许提前返还属性。

参数

szURL - [IN] 集团授权服务器地址，包括端口。如输入NULL，则使用配置文件地址；如输入 * 号，则使用广播查找地址。
featureId - [IN] 指定要返还授权码需要包含的特征项ID，为 0 则寻找第一个可返还授权码。
xmlScope - [IN] 用于指定借出的参数，格式：wsxxxx，type设定为ws时表示从云授权服务器借出和归还。
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetInfo

    BIT_STATUS Bit_GetInfo (
                 BIT_PCSTR szSN,
                 BIT_UCHAR * pApplicationData,
                 INFO_TYPE type,
                 BIT_CHAR * pInfo,
                 BIT_UINT32 * pInfoSize)

获取授权信息及使用环境信息，数据以XML格式返回。调用此函数前客户端不需要执行登录操作。

参数

szSN - [IN] 授权码（SN）字符串
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
type - [IN] 获取信息类型。
pInfo - [OUT] 用于存储返回XML信息数据的存储区地址。
pInfoSize - [IN/OUT] 输入的存储区长度。

type 类型

BIT_INFO_SERVER_ADDRESS - 获取局域网内的集团授权服务器地址列表
BIT_INFO_SN - 获取本机已激活的授权码列表
BIT_INFO_SN_FEATURE - 获取本机已激活授权码的特征项列表
BIT_INFO_SN_LICENSE - 获取本机已激活授权码的授权信息
BIT_INFO_UPDATE_ERROR - 获取指定授权码的升级错误详细信息。是否存在详细信息由授权码类型及错误类型决定
BIT_INFO_CONFIG - 获取当前产品的配置文件信息
BIT_INFO_TOKEN_LIST - 获取当前机器上可用的BIT-ID列表信息

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_RemoveSn

    BIT_STATUS Bit_RemoveSn (
                 BIT_PCSTR szSN,
                 BIT_UCHAR * pApplicationData)

删除指定授权码在本机的授权数据，可用于测试或当授权数据出现问题而不能通过升级解决时的故障处理。

参数

szSN - [IN] 授权码（SN）字符串
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_SetCustomInfo

    BIT_STATUS Bit_SetCustomInfo (
                 BIT_UINT32 infoId,
                 BIT_PCSTR pInfoData,
                 BIT_UINT32 infoDataSize)

设置客户端运行自定义信息，需要在可能使用自定义信息的API（如Login）前调用。

参数

infoId - [IN] 要设置的自定义信息类型。
pInfoData - [IN] 自定义信息存储区地址。
infoDataSize - [IN] 自定义信息长度。

infoId 类型

CUSTOM_CLIENT_ID - 自定义客户端唯一的机器标识，该自定义标识会发送给服务器并用于今后的机器指纹匹配
CUSTOM_COMMENT - 自定义客户端登录注释，用于集团服务管理员获取用户登录请求信息

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetVersion

    BIT_STATUS Bit_GetVersion (
                 BIT_UINT32 * pVersion)

获取客户端安全库版本号。

参数

pVersion - [OUT] 客户端安全库版本号。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetTicketInfo

    BIT_STATUS Bit_GetTicketInfo (
                 BIT_TICKET ticket,
                 BIT_UINT32 type,
                 BIT_CHAR * pXmlInfo,
                 BIT_UINT32 * pSize)

查看指定ticket的相关信息。

参数

ticket - [IN] 通过QueryFeatureEx2函数返回的上下文句柄。
type - [IN] 获取ticket的信息类型。
pXmlInfo - [OUT] ticket信息存储区地址。
pSize - [IN/OUT] 输入时为存储区长度，输出时为返回信息的长度。

type 类型

BIT_TICKET_TYPR_USERS - 获取当前 ticket 占用的用户数

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_SetAttr

    BIT_STATUS Bit_SetAttr (
                 BIT_HANDLE handle,
                 BIT_UINT32 type,
                 BIT_VOID * pValue)

设置回调函数、阻塞队列超时时间、心跳重试次数、心跳重试间隔等。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
type - [IN] 设置函数功能类型。
pValue - [IN] 阻塞队列超时时间或者是回调函数地址等。

type 类型

ATTR_HB_RETRY_FAILED_CALLBACK - 心跳回调函数
ATTR_WAIT_TIMEOUT - 阻塞队列超时时间，最小16秒，最大24小时，默认是一直等待
ATTR_RETRY_COUNT - 客户端连接服务的重试次数。最小0次，最大1024次。默认是0次
ATTR_RETRY_INTERVAL - 客户端连接服务的重试间隔，最小是10秒，最大是4小时，默认是20秒
ATTR_CONNECT_TIMEOUT - 网络连接超时时间，最小是1秒，最大是32秒，默认是3秒
ATTR_CONNECT_RETRY_COUNT - 网络连接重试次数，最小是0次，最大是10次，默认是3次

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetFeatureInfo2

    BIT_STATUS Bit_GetFeatureInfo2 (
                 BIT_HANDLE handle,
                 BIT_PCSTR  featureName,
                 BIT_PCSTR  xmlScope,
                 BIT_INT32  * pExpired)

检查特征项是否存在，不会占用授权码或特征项的用户数，获取特征项的剩余有效期。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureName - [IN] 产品的特征项名称。
xmlScope - [IN] 特征项的版本，可以通过xml格式传入版本，也可以直接传入版本的字符串。
pExpired - [OUT] 返回该特征项的剩余有效期，正数代表剩余有效期，负数代表过期天数，36500代表永久有效。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetFeatureInfoEx2

    BIT_STATUS BIT Bit_GetFeatureInfoEx2(
                 BIT_HANDLE handle,
                 BIT_PCSTR  featureName,
                 BIT_PCSTR  xmlScope,
                 BIT_CHAR   *pFeatureInfo,
                 BIT_UINT32 *pFeatureInfoSize);

获取指定feature的信息，以XML格式返回。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
featureName - [IN] 产品的特征项名称。
xmlScope - [IN] 特征项支持小数版本，可以通过 xml 格式传入版本，也可以直接传入版本的字符串。
pFeatureInfo - [OUT] feature信息存储区地址。
pFeatureInfoSize - [IN/OUT] 会话存储区大小。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_SetSessionState

    BIT_STATUS Bit_SetSessionState (
                 BIT_HANDLE handle,
                 BIT_UINT32 state,
                 BIT_VOID * pReserved)

设置客户端的状态为空闲状态或繁忙状态或激活状态。

参数

handle - [IN] 通过Login函数返回的上下文句柄。
state - [IN] 设置客户端的状态选项。
pReserved - [IN] 目前保留必须传NULL。

state 类型

SESSION_STATE_UNSET - 表示不设置客户端的状态
SESSION_STATE_IDLE - 表示设置客户端为空闲态
SESSION_STATE_BUSY - 表示设置客户端为繁忙态
SESSION_STATE_ACTIVE - 表示设置客户端为激活态

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_SetLocalServer

    BIT_STATUS Bit_SetLocalServer (
                 BIT_UCHAR * pApplicationData,
                 BIT_PCSTR szHostName,
                 BIT_UINT32 nPort,
                 BIT_UINT32 nTimeoutSecondes)

设置集团服务的地址和端口。

参数

pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
szHostName - [IN] 集团服务所安装机器的IP地址。
nPort - [IN] 客户端应用程序的通讯端口，默认为 8273。
nTimeoutSecondes - [IN] 客户端超时秒数。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_TestBitService

    BIT_STATUS Bit_TestBitService (
                 BIT_PCSTR szURL,
                 BIT_PCSTR szSN,
                 BIT_UINT32 featureId,
                 BIT_UCHAR * pApplicationData)

测试集团授权的特征项是否可用，不会占用授权码或特征项的用户数。

参数

szURL - [IN] 自定义授权服务器地址，包括端口。如未使用自定义授权服务器则为NULL。
szSN - [IN] 授权码（SN）字符串。如果为空（空串或NULL）则尝试寻找所有当前本机可用的SN
featureId - [IN] 登录授权所需要包含的特征项ID
pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_SetRootPath

    BIT_STATUS Bit_SetRootPath (
                 BIT_PCSTR szPath)

设置授权文件的存储路径。

参数

szPath - [IN] 数据缓存区地址，用于存储授权文件的路径。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_GetProductPath

    BIT_STATUS Bit_GetProductPath (
                 BIT_UCHAR * pApplicationData,
                 BIT_CHAR * pBuf,
                 BIT_UINT32 lenBuf)

获取授权存储目录。

参数

pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
pBuf - [OUT] 数据缓存区地址，用于存储授权目录。
lenBuf - [IN] 授权目录数据长度。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。

Bit_SetProxy

    BIT_STATUS Bit_SetProxy (
                 BIT_UCHAR * pApplicationData,
                 BIT_PCSTR szHostName,
                 BIT_UINT32 nPort,
                 BIT_PCSTR szUserID,
                 BIT_PCSTR szPassword)

设置代理服务的地址和端口。

参数

pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
szHostName - [IN] 代理服务所在机器的IP地址。
nPort - [IN] 客户端应用程序的通讯端口，默认为 8273。
szUserID - [IN] 代理服务所在机器的用户名。
szPassword - [IN] 代理服务所在机器的密码。

如果返回值为零，表示此函数调用成功。如果非零，可以根据返回值，从错误码表中查看具体的错误原因。