Browse Source

接口说明

Jeff 5 năm trước cách đây
mục cha
commit
e1d50779c0
1 tập tin đã thay đổi với 22 bổ sung10 xóa
  1. 22 10
      scbc.tools/test/ReadMe.txt

+ 22 - 10
scbc.tools/test/ReadMe.txt

@@ -21,9 +21,17 @@ https:curlib+openssl+zlib
 Windows:xp sp3
 
 /************************************************************************************************/
-/*				 简要接口说明:				*/
+/*	                                   简要接口说明:                                           */
 /************************************************************************************************/
-1、extern SCBCTOOLS_API int QueryMidInfo(const char* lpOrder);
+1、extern SCBCTOOLS_API bool ScbcInit(const char* lpOrder);
+描述:使用批次号初始化https接口环境。
+	DownloadMidData、ReportKeyCopyResults、BatchReportKeyCopyResults前调用;
+参数:lpOrder 批次号;
+返回:
+	true成功;false失败;
+
+
+2、extern SCBCTOOLS_API int QueryMidInfo(const char* lpOrder);
 描述:查询指定批次MID信息。
 	一般用于DownloadMidData调用后,查询是否下载成功;或者下载前,查询该批次是否已经在下载中;
 参数:lpOrder 批次号;
@@ -38,7 +46,7 @@ Windows:xp sp3
 	-4=表示数据异常;
 
 
-2、extern SCBCTOOLS_API int DownloadMidData(const char* lpOrder);
+3、extern SCBCTOOLS_API int DownloadMidData(const char* lpOrder);
 描述:下载指定批次MID数据;(后台线程下载),调用QueryMidInfo查询是否下载完成;
 参数:lpOrder 批次号;
 返回:
@@ -51,7 +59,8 @@ Windows:xp sp3
 	-4=表示数据异常;
 	-5=表示https网络请求失败;
 
-3、extern SCBCTOOLS_API int QueryKeyInfo(const char* lpSN, SNKeys &snKeys);
+
+4、extern SCBCTOOLS_API int QueryKeyInfo(const char* lpSN, SNKeys &snKeys);
 描述:查询SN对应的Keys;
 参数:
 	lpSN 条码;
@@ -66,7 +75,7 @@ Windows:xp sp3
 	-4=表示数据异常;
 
 
-4、extern SCBCTOOLS_API int UpdateKeyCopyStatus(const char* lpSN);
+5、extern SCBCTOOLS_API int UpdateKeyCopyStatus(const char* lpSN);
 描述:更新抄写状态;(在抄写key成功后调用该接口)
 参数:lpSN 条码;
 返回:
@@ -75,7 +84,8 @@ Windows:xp sp3
 	-1=表示lpSN参数空;
 	-2=表示打开数据库失败;
 
-5、extern SCBCTOOLS_API int UpdateKeyReportStatus(const char* lpSN);
+
+6、extern SCBCTOOLS_API int UpdateKeyReportStatus(const char* lpSN);
 描述:更新上报状态;(的UpdateKeyCopyStatus成功后调用)
 参数:lpSN 条码;
 返回:
@@ -84,7 +94,8 @@ Windows:xp sp3
 	-1=表示lpSN参数空;
 	-2=表示打开数据库失败;
 
-6、extern SCBCTOOLS_API int ReportKeyCopyResults(const char* lpSN);
+
+7、extern SCBCTOOLS_API int ReportKeyCopyResults(const char* lpSN);
 描述:上报抄写结果;
 参数:lpSN 条码;
 返回:
@@ -100,7 +111,7 @@ Windows:xp sp3
 	-8=表示上报抄写结果成功,但更新上报状态失败;此时,需调用UpdateKeyReportStatus更新上报状态;
 
 
-7、extern SCBCTOOLS_API int BatchReportKeyCopyResults();
+8、extern SCBCTOOLS_API int BatchReportKeyCopyResults();
 描述:批量上报抄写结果。从数据库查询出1000条未上报的sn进行上报;
 参数:无;
 返回:
@@ -115,7 +126,8 @@ Windows:xp sp3
 	-7=表示上报抄写结果失败;
 	-8=表示上报抄写结果成功,但批量更新上报状态失败;
 
-8、extern SCBCTOOLS_API int QueryBidInfo(const char* lpOrder, BidInfo& binfo);
+
+9、extern SCBCTOOLS_API int QueryBidInfo(const char* lpOrder, BidInfo& binfo);
 描述:查询批次信息:应下载sn数、实际下载sn数、抄写成功数量、上报成功数量;
 参数:lpOrder 批次号; binfo 返回的bid信息;
 返回:
@@ -128,7 +140,7 @@ Windows:xp sp3
 注意:一般情况下,应下载数sn数量=实际下载sn数量;
 
 
-9、extern SCBCTOOLS_API int RemoveBidData(const char* lpOrder);
+10、extern SCBCTOOLS_API int RemoveBidData(const char* lpOrder);
 描述:删除批次相关的所有表数量;
 参数:lpOrder 批次号;
 返回: