API 帮助工具

API帮助工具是Virbox LM体系下方便用户调试用户锁的一个工具。是对API调用的一种演示，您可以在这里对API的调用进行操作，省去每次调试时的编译步骤。可以通过工具盒左侧菜单找到它。

API帮助工具主要分为5个区域：函数列表区（左侧上方），Handles区（左侧下方）， 参数指定区（右侧上方），代码演示区（右侧下方），还有右上角的开发者ID区。

• 函数列表区
  在左侧上部这块高亮区域为函数列表区域。该区域中展示的是当前API帮助工具中支持直接测试的所有函数。在测试时需要注意下API的一般调用流程:

slm_init() -> slm_login() -> 其它需要调用的函数 -> slm_logout() -> slm_cleanup()

• 参数指定区
  在右侧上方的高亮区域中为参数指定区域。该区域会根据各种函数需要的参数不同而变化。下面两张图片展示的是slm_init和slm_find_license需要的参数。
  
  当您指定好需要的参数后，点击该区域下方的Execute按钮，API帮助工具就会根据您指定的参数去调用API作相应的动作。如果某一函数有返回数据(通过参数列表返回的数据，不包括函数返回值)时，会在该区域下方的Output Data区域中展示出来。
  
  而跟在Execute后面的两个小区域分别表示函数执行的返回码(return),以及返回码对应的描述。

• Handles区
  Handle是API中的一个句柄值，该值是在使用slm_login()函数登录时返回的，当您在API帮助工具中使用slm_login登录许可并且返回码显示为成功时，会在该区域中出现一个数字，该数字就是slm_login()函数返回给我们的句柄值（也可以说是一个会话值），在之后的一些操作、调用函数时很多都会用到该句柄值。
  需要注意，每次执行slm_login()成功时都会有一个新的句柄值产生。如果想释放某个句柄，需要使用鼠标选中相应的句柄，并在上方的函数列表中找到slm_logout函数，并点击右侧高亮区域中的Execute按钮。

• 代码演示区
  该区域中会显示一个与所选函数相关的一段代码调用的演示。

• 开发者ID
  在API帮助工具右上角会显示当前开发者所使用的开发者ID。 该ID与slm_init()函数中使用的API密码是一一对应的。如果在使用该工具时出现api密码错误时可能是开发者ID与开发者API密码不匹配造成的。