C API 函数


ApplySolution

说明

ApplySolution 指示“自适应学习”将 pszDescription 指定的说明应用于 nSolutionID 标识的解决方案。

注:ApplySolution 用于提高 ADL 匹配的准确性,而不是要关闭问题。

语法

int ApplySolution(long nAPIHandle, long nSolutionID, const char* pszDescription,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

nSolutionID - 进行更新的自适应学习解决方案的标识。

pszDescription - 添加到自适应学习解决方案的说明。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出传送给 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


AttachProblemHistory

说明

AttachProblemHistory 将记录附到现存问题上。

语法

int AttachProblemHistory(long nAPIHandle, const char* pszProblemID,
const HISTORY_ATTACHMENT* pNewHistoryRecord, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL)

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszProblemID - 要附上问题历史信息的问题标识。

pNewHistoryRecord - 说明要附上的问题历史的 HISTORY_ATTACHMENT 记录。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出传送给 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


AttachWorkHistory

说明

AttachProblemHistory 将记录附到现存问题上。

语法

int AttachWorkHistory(long nAPIHandle, const char* pszProblemID,
const HISTORY_ATTACHMENT* pNewHistoryRecord, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszProblemID - 要附上问题历史信息的问题标识。

pNewHistoryRecord - 说明要附上的工作历史的 HISTORY_ATTACHMENT 记录。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出传送给 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


CloseRequest

说明

CloseRequest 关闭指定的请求。

语法

int CloseRequest(long nAPIHandle, char* pszRequestID, PROBLEM_CLOSURE* pProblem,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszRequestID - 要关闭的请求的标识。

pProblem - PROBLEM_CLOSURE 记录,说明关闭请求所必需的信息。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


Connect

说明

Connect 初始化 C API 并尝试使用提供的标识和密码来注册。如果注册成功,则初始化 pAPIHandle。

注:没有有效的 pAPIHandle 就不能调用 C API 函数。

语法

int Connect(long* pAPIHandle, const char* pszHostName, unsigned int nHostPort,
const char* pszUserID, const char* pszPassword, long* pnError, int nUserType = 1 )

自变量

pAPIHandle - 指向变量的指针,返回时包含要传送给 C API 函数的句柄。

pszHostName - 机器的名称或 IP 地址,该机器主持 C API 与之进行交流的应用程序服务器。

nHostPort - ES DISPATCHER SERVICE 在应用程序服务器上监听的端口号码。

pszUserID - 连接到应用程序服务器的用户之名。

pszPassword - 与 pszUserID 指定的用户相匹配的口令。

pnError - 如果在处理过程中出现错误,则该变量包含 SQL 错误号码。

nUserType - 指定注册用户类型的可选参数。在缺省情况下,用户类型是 1,这表示“专家顾问”用户。类型 2 指定“专家网络”用户。

返回

int - 请求的状态,可以是 SAI_OK、SAI_SQL_ERROR、或表示已出现错误的 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


CreateRequest

说明

CreateRequest 新建一个请求,并让它在应用程序服务器上保持打开状态。如果呼叫成功,则在 szRequestID 中返回新请求的标识。

注:应在呼叫 CreateRequest 之前将 szRequestID 设置为“空”。

语法

int CreateRequest(long nAPIHandle, PROBLEM_CLOSURE* pProblem, char** ppszRequestID,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pProblem - PROBLEM_CLOSURE 记录,说明要创建的请求。

ppszRequestID - 已创建请求的标识。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


CustomMessage

说明

CustomMessage 提供一种用于用户定义的 C API 调用的机制,能让用户将名称-数值对列表发送给应用程序服务器。CustomMessage 使用在 nActionMessageID 中指定的消息编号来提交数据。它保证应用程序服务器使用在 nResponseMessageID 中指定的消息来响应。如果呼叫成功,则 ppResponseData 包含来自应用程序服务器的响应。要利用 CustomMessage,必须修改应用程序服务器源代码,并添加消息编号和处理指定的“操作与响应”消息的能力。

语法

int CustomMessage(long nAPIHandle, int nActionMessageID, int nResponseMessageID,
const EXTENDED_DATA* pMessageData, EXTENDED_DATA** ppResponseData, long* pnError )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

nActionMessageID - 用于提交 pMessageData 的消息编号。

nResponseMessageID - 应用程序服务器用来响应的消息标识。

pMessageData - 将作为 nActionMessageID 参数而传送给应用程序服务器的 EXTENDED_DATA 列表。

ppResponseData - 处理 nActionMessageID 后,从应用程序服务器返回的响应。

pnError - 如果出现错误,则该变量包含 SQL 错误号码

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


Disconnect

说明

Disconnect 清除 C API 分配的内存,并终断与应用程序服务器的连接。

注:在调用 Disconnect 后,nAPIHandle 不再有效,而且在重新调用 Connect 之前,不能调用 C API 函数。

语法

int Disconnect( long nAPIHandle )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

返回

int - 请求的状态,可以是 SAI_OK、或表示已出现错误的 SAI_SQL_ERROR 和 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


ExecuteSQL

说明

ExecuteSQL 将执行任何 SQL 语句(选择语句除外)。请确保对象名具有适用的限定词。

语法

int ExecuteSQL( long nAPIHandle, const char* pszSQLStatement,
long* pnError )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszSQLStatement - 要在服务器上执行的 SQL 语句。

pnError - 如果出现错误,则该变量包含 SQL 错误号码

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


FreeCallList

说明

FreeCallList 清除 CALL_SESSION 列表使用的内存。由于应用程序必须释放它占用的内存,所以该函数释放 DLL 分配的内存。

语法

void FreeCallList( long nAPIHandle, CALL_SESSION** ppCallList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppCallList - 指向要放弃的呼叫列表的表头。


FreeContactList

说明

FreeContactLis 清除 CONTACT_RECORD 列表使用的内存。由于应用程序必须释放它占用的内存,所以该函数释放 DLL 分配的内存。

语法

void FreeContactList(long nAPIHandle, CONTACT_RECORD** ppContactList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppContactList - 指向要放弃的联系人列表的表头。


FreeExtendedDataList

说明

FreeExtendedDataList 清除 EXTENDED_DATA 列表使用的内存。由于占用内存的应用程序必须释放内存,所以该函数释放由 DLL 分配的内存。

注:不能将该函数用于释放由 C API 用户分配的列表。必须用其他方法清除用户创建来将扩展数据参数传送给 C API 调用的任何列表。

语法

void FreeExtendedDataList(long nAPIHandle, EXTENDED_DATA** ppExtendedDataList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppExtendedDataList - 指向要放弃的扩展数据项列表的表头。


FreeHierarchyList

说明

FreeHierarchyList 清除 HIERARCHY_RECORD 列表使用的内存。由于占有内存的应用程序必须释放内存,所以该函数释放由 DLL 分配的内存。

注:除列表之外,还可以释放通过调用 GetLocationTree 或 GetOrganizationTree 而获得的单个 HIERARCHY_RECORD 所使用的内存。

语法

void FreeHierarchyList( long nAPIHandle, HIERARCHY_RECORD** ppHierarchyList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppHierarchyList - 指向要放弃的 HIERARCHY_RECORD 列表的表头。


FreeHistoryList

说明

FreeHistoryList 清除 HISTORY_RECORD 列表使用的内存。由于占有内存的应用程序必须释放内存,所以该函数释放 DLL 分配的内存。

语法

void FreeHistoryList(long nAPIHandle, HISTORY_RECORD** ppHistoryList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppHistoryList - 指向要放弃的历史记录列表的表头。


FreeHypernodeList

说明

FreeHypernodeList 清除 HYPERTREE_NODE 列表使用的内存。由于占有内存的应用程序必须释放内存,所以该函数释放 DLL 分配的内存。

注:除列表之外,还可以释放从对 GetHypernode 的调用中获得的单个 HYPERTREE_NODE 所使用的内存。

语法

void FreeHypernodeList( long nAPIHandle, HYPERTREE_NODE** ppHypernodeList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppHypernodeList - 指向要放弃的超级节点列表的表头。


FreeLocationList

说明

FreeLocationList 清除 LOCATION_RECORD 列表使用的内存。由于占有内存的应用程序必须释放内存,所以该函数释放由 DLL 分配的内存。

注:除列表之外,还可以释放从对 GetLocation 的调用中获得的单个 LOCATION_RECORD 所使用的内存。

语法

void FreeLocationList(long nAPIHandle, LOCATION_RECORD** ppLocationList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppHistoryList - 指向要放弃的场所列表的表头。


FreeProblemViewList

说明

FreeProblemViewList 清除 PROBVIEW_RECORD 列表使用的内存。由于占有内存的应用程序必须释放内存,所以该函数释放 DLL 分配的内存。

注:除列表之外,还可以释放从对 GetProblemView 的调用中获得的单个 PROBVIEW_RECORD 所使用的内存。

语法

void FreeProblemViewList (long nAPIHandle, PROBVIEW_RECORD** ppProbViewList)

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppProbViewList - 指向要放弃的问题视图列表的表头。


FreeRequestList

说明

FreeRequestList 清除 PROBLEM_RECORD 列表使用的内存。由于占有内存的应用程序必须释放内存,所以该函数释放 DLL 分配的内存。

注:除列表之外,还可以释放从对 GetRequest 的调用中获得的单个 PROBLEM_RECORD 所使用的内存。

语法

void FreeRequestList(long nAPIHandle, PROBLEM_RECORD** ppProblemList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppProblemList - 指向要放弃的问题列表的表头。


FreeResponseList

说明

FreeResponseList 清除 HYPERTREE_RESPONSE 列表使用的内存。由于占有内存的应用程序必须释放内存,所以该函数释放 DLL 分配的内存。

语法

void FreeResponseList(long nAPIHandle, HYPERTREE_RESPONSE** ppResponseList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppProblemList - 指向要放弃的超级树响应列表的表头。


FreeSolutionList

说明

FreeSolutionList 清除 SOLUTION_RECORD 列表使用的内存。由于占有内存的应用程序必须释放内存,所以提供该函数来释放由 DLL 分配的内存。

语法

void FreeSolutionList(long nAPIHandle, SOLUTION_RECORD** ppSolutionList )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppSolutionList - 指向要放弃的解决方案列表的表头。


GetAdaptiveLearning

说明

给定问题的说明后,GetAdapativeLearning 从数据库中取装一个自适应学习解决方案列表。

注:数据库检索的项目不会多于最大数。

语法

int GetAdaptiveLearning(long nAPIHandle, const REQUEST_CONTEXT* pRequest,
SOLUTION_RECORD** ppSolutionList, long*pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pRequest - 说明需要一个解决方案列表的问题的结构。

ppSolutionList - 在返回时列出用于指定请求的解决方案。

pnMaxRequested - 根据初始调用指定要检索的解决方案的最大数目。在返回时,在 ppSolutionList 中指定实际解决方案数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetCallCodes

说明

GetCallCodes 取装一个所有已知呼叫代码的列表。

语法

int GetCallCodes(long nAPIHandle, STRING_ARRAY* pszCallCodeList, long* nReturnCount,
long* pnError )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszCallCodeList - 在返回时列出系统中的所有呼叫代码。

nReturnCount -在返回时,在 pszCallCodeList 中指定字符串数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetCalls

说明

GetCalls 取装指定问题的一个呼叫列表和会话记录。

语法

int GetCalls(long nAPIHandle, const char* pszProblemID, CALL_SESSION** ppCallList,
long* pnMaxRequested, long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszProblemID - 要检索其详细信息的问题的标识。

ppCallList - 在返回时,列出属于指定问题的呼叫和会话记录。

pnMaxRequested - 在初始呼叫时,指定要检索的记录的最大数目。在返回时,在 ppCallList 中指定记录的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetCommonProblems

说明

给定问题的说明后,GetCommonProblems 从数据库中取装一个“公共问题”解决方案列表。

注:数据库检索的项目不会多于指定的最大数。

语法

int GetCommonProblems(long nAPIHandle, const REQUEST_CONTEXT* pRequest,
SOLUTION_RECORD**ppSolutionList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pRequest - 说明需要一个解决方案列表的问题的结构。

ppSolutionList - 在返回时列出用于指定请求的解决方案。

pnMaxRequested - 在初始呼叫时,指定要检索的解决方案的最大数目。在返回时,在 ppSolutionList 中指定解决方案的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetContact

说明

GetContact 取装特定联系人的有关信息。

注:联系人必须与场所相关联。

语法

int GetContact(long nAPIHandle, const char* contact_id, const char* pszContactID,
const char* pszLocationID, CONTACT_RECORD** ppContact, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszContactID - 要检索的联系人标识。

pszLocationID - 其联系人有效的场所的标识。

ppContact - 在返回时,包含联系人的有关信息,该联系人具有位于 pszLocationID 的 pszContactID 的标识。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetErrorMessages

说明

给定问题的说明后,GetErrorMessages 从数据库中取装一个出错消息解决方案列表。

注:数据库检索的项目不会多于最大数。

语法

int GetErrorMessages(long nAPIHandle, const REQUEST_CONTEXT* pRequest,
SOLUTION_RECORD** ppSolutionList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pRequest - 说明需要一个解决方案列表的问题的结构。

ppSolutionList - 在返回时列出用于指定请求的解决方案。

pnMaxRequested - 在初始呼叫时,指定要检索的解决方案的最大数目。在返回时,在 ppSolutionList 中指定解决方案的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetGroups

说明

GetGroups 取装组列表。

注:数据库检索的项目不会多于最大数。

语法

int GetGroups(long nAPIHandle, GROUP_RECORD** ppGroupList, long* pnMaxRequested,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppGroupList - 在返回时,列出每个组,数目达到在 pnMaxRequested 中指定的最大数。

pnMaxRequested - 在初始呼叫时,指定要检索的组的最大数目。在返回时,在 ppGroupList 中指定组的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetHotNews

说明

给定问题的说明后,GetHotNews 从数据库中取装一个“热点新闻”解决方案列表。

注:数据库检索的项目不会多于最大数。

语法

int GetHotNews(long nAPIHandle, const REQUEST_CONTEXT* pRequest,
SOLUTION_RECORD** ppSolutionList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pRequest - 说明需要一个解决方案列表的问题的结构。

ppSolutionList - 在返回时列出用于指定请求的解决方案。

pnMaxRequested - 在初始呼叫时,指定要检索的解决方案的最大数目。在返回时,在 ppSolutionList 中指定解决方案的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetHypernode

说明

GetHypernode 取装对应于指定标识的超级节点记录的有关信息。

语法

int GetHypernode(long nAPIHandle, long nHypernodeID, HYPERTREE_NODE** ppHypernode,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

nHypernodeID - 要检索的超级接点标识。

ppHypernode - 指向包含指定标识的超级节点信息的记录。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetHypernodeResponses

说明

GetHypernodeResponses 取装与指定的超级节点标识相关联的响应记录。

注:数据库检索的项目不会多于指定的最大数。

语法

int GetHypernodeResponses(long nAPIHandle, long nHypernodeID,
HYPE RTREE_RESPONSE** ppResponseList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

nHypernodeID - 要用于检索响应的超级节点标识。

ppResponseList - 在返回时,列出属于指定的超级节点的响应记录。

pnMaxRequested - 在初始呼叫时,指定要检索的解决方案的最大数目。在返回时,在 ppResponseList 中指定解决方案的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetHyperTrees

说明

给定问题的说明后,GetHyperTrees 从数据库中取装一个“超级树”条目级的节点的列表。

注:数据库检索的项目不会多于指定的最大数。

语法

int GetHyperTrees(long nAPIHandle, const REQUEST_CONTEXT* pRequest,
HYPERTREE_NODE** ppHyperTreeList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pRequest - 说明需要一个超级节点列表的问题的结构。

ppHyperTreeList - 在返回时,列出满足请求的超级树的节点。

pnMaxRequested - 在初始呼叫时,指定要检索的超级节点的最大数目。在返回时,在 ppHyperTreeList 中指定超级节点的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetLocation

说明

GetLocation 取装特定场所的有关信息。

语法

int GetLocation(long nAPIHandle, const char* pszLocationID, LOCATION_RECORD** ppLocation,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszLocationID - 场所标识。

ppLocation - 在返回时,包含具有 pszLocationID 标识的场所的有关信息。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetLocationTree

说明

GetLocationTree 取装与过滤器标准相匹配的“场所分层”信息。

语法

int GetLocationTree( long nAPIHandle, const HIERARCHY_FILTER*
pLocationFilter, HIERARCHY_RECORD** ppLocationList, long* nReturnCount,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pLocationFilter - HIERARCHY_FILTER 记录,说明用于检索场所列表的搜索标准。

ppLocationList - 在返回时,列出与过滤器标准相匹配的场所。

nReturnCount -在返回时,在 ppLocationList 中指定场所数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetOrganizationTree

说明

GetOrganizationTree 取装与过滤器标准相匹配的“组织分层”信息。

语法

int GetOrganizationTree( long nAPIHandle, const HIERARCHY_FILTER*
pOrganizationFilter, HIERARCHY_RECORD** ppOrganizationList, long*
nReturnCount, long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pOrganizationFilter - HIERARCHY_FILTER 记录,说明用于检索组织列表的搜索标准。

ppOrganizationList - 在返回时,列出与过滤器标准相匹配的组织。

nReturnCount -在返回时,在 ppOrganizationList 中指定组织数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetProblemHistory

说明

GetProblemHistory 取装指定问题的问题历史。

语法

int GetProblemHistory(long nAPIHandle, const char* pszProblemID,
HISTORY_RECORD** ppHistoryList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszProblemID - 要检索其问题历史信息的问题的标识。

ppHistoryList - 在返回时,列出指定问题的问题历史记录。

pnMaxRequested - 在初始呼叫时,指定要检索的记录的最大数目。在返回时,在 ppHistoryList 中指定记录的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetProblemView

说明

GetProblemView 取装与指定问题相关联的问题视图记录。

语法

int GetProblemView (long nAPIHandle, const char* pszProblemID, PROBVIEW_RECORD** ppProbView,
long* pnError, const EXTENDED_DATA* pUserDefinedData /*=NULL*/)

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszProblemID - 要检索其问题视图信息的问题的标识。

ppProbView - 指向包含问题视图信息的记录。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetRequest

说明

GetRequest 取装指定请求的摘要信息。

语法

int GetRequest(long nAPIHandle, const char* pszProblemID, PROBLEM_RECORD** ppProblem,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszProblemID - 要检索其摘要信息的问题的标识。

ppProblem - 指向包含请求摘要信息的记录。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetRequestDetails

说明

GetRequestDetails 取装指定请求的详细信息。

语法

int GetRequestDetails(long nAPIHandle, const char*pszProblemID, PROBLEM_RECORD** ppProblem,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszProblemID - 要检索其详细信息的问题的标识。

ppProblem - 指向具有请求详细信息的记录。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetRequestTypes

说明

GetRequestTypes 取装一个所有已知请求类型的列表。

语法

int GetRequestTypes(long nAPIHandle, STRING_ARRAY* pszRequestTypeList,
long* nReturnCount, long* pnError )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszRequestTypeList - 在返回时,列出系统中的各种请求。

nReturnCount -在返回时,在 pszRequestTypeList 中指定字符串实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetSCIMLevelList

说明

GetSCIMLevelList 检索指定级别的下一级 SCIM 中的一个项目列表。例如,如果指定的是“系统”,则返回该系统的所有“组件”。

注:数据库检索的项目不会多于 pnMaxRequested。

语法

int GetSCIMLevelList(long nAPIHandle, const SCIM_KEY* pSCIMKey,
STRING_ARRAY* pszSCIMLevelList, long* pnMaxRequested, long* pnError )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pSCIMKey - 对基于下一级 SCIM 的当前级 SCIM 进行说明的结构。

pszSCIMLevelList - 在返回时,列出列出请求的 SCIM 级的每个字符串。

pnMaxRequested - 在初始呼叫时,指定要检索的 SCIM 字符串的最大数目。在返回时,在 pszSCIMLevelList 中指定字符串实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetSeverities

说明

GetSeverities 取装一个所有已知严重性的列表。使用下列格式提供结果:“#:Description”,其中,# 为表示严重性级别的数字。

语法

int GetSeverities(long nAPIHandle, STRING_ARRAY* pszSeverityList,
long* nReturnCount, long* pnError )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszSeverityList - 在返回时,列出系统中的各种严重性。

nReturnCount -在返回时,在 pszSeverityList 中指定字符串数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetSupportingOrganizationIDs

说明

GetSupportingOrganizationIDs 取装一个组织列表,根据查看的对象和指定的组织为,这些组织当前被认为是可支持的。

语法

int GetSupportedOrganizationIDs( long nAPIHandle, const char* pszOrganizationID,
const char* pszTableName, STRING_ARRAY* pszOrgIDList, long* nReturnCount, long*
pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszOrganizationID - 被认为是当前受支持的组织。该组织将成为确定支持域的搜索方法的起点。

pszTableName - 保留正查看的数据的表。

pszOrgIDList - 在返回时,指定组成支持域的组织。

nReturnCount - 在初始呼叫时,指定要检索的组织的最大数目。在返回时,指定返回的组织数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetUsers

说明

GetUsers 取装用户列表。

注:数据库检索的项目不会多于指定的最大数。

语法

int GetUsers(long nAPIHandle, USER_RECORD** ppUserList, long* pnMaxRequested,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

ppGroupList - 在返回时,列出系统中的各个用户,数目达到由 pnMaxRequested 指定的最大数。

pnMaxRequested - 在初始呼叫时,指定要检索的用户的最大数目。在返回时,在 ppUserList 中指定用户实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetUserOrganizationIDs

说明

GetUserOrganizationIDs 取装一个附属了指定用户的组织列表。如果用户类型表示 TSD 用户,则返回支持的组织。如果提供的是 Web 用户,则返回该用户为其成员的组织。

语法

int GetUserOrganizationIDs( long nAPIHandle, const char* pszUserID, int nUserType,
STRING_ARRAY* pszOrgIDList, long* nReturnCount, long* pnError, const EXTENDED_DATA*
pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszUserID - 要根据它来取装组织的用户标识。

pszOrgIDList - 在返回时,指定附属了 pszUserID 的组织。

nReturnCount - 在初始呼叫时,指定要检索的组织的最大数目。在返回时,指定返回的组织数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。
pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


GetWorkHistory

说明

GetProblemHistory 取装指定问题的工作历史。

语法

int GetWorkHistory(long nAPIHandle, const char* pszProblemID,
HISTORY_RECORD** ppHistoryList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszProblemID - 用来检索工作历史信息的问题标识。

ppHistoryList - 在返回时,列出指定问题的工作历史记录。

pnMaxRequested - 在初始呼叫时,指定要检索的记录的最大数目。在返回时,在 ppHistoryList 中指定记录的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


InitContactFilter

说明

InitContactFilter 将 CONTACT_FILTER 数据成员设置为缺省值,以显示未用的字段。

语法

void InitContactFilter(long nAPIHandle, CONTACT_FILTER* pContactFilter )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pContactFilter - 指向将用缺省值来初始化的 CONTACT_FILTER 结构。


InitHierarchyFilter

说明

InitHierarchyFilter 将 HIERARCHY_FILTER 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitHierarchyFilter( long nAPIHandle, HIERARCHY_FILTER* pHierarchyFilter )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pHierarchyFilter - 指向要使用缺省值来初始化的 HIERARCHY_FILTER 结构。


InitHistoryAttachment

说明

InitHistoryAttachment 将 HISTORY_ATTACHMENT 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitHistoryAttachment(long nAPIHandle, HISTORY_ATTACHMENT* pHistoryAttachment )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pHistoryAttachment - 指向将使用缺省值来初始化的 HISTORY_ATTACHMENT 结构。


InitLocationFilter

说明

InitLocationFilter 将 LOCATION_FILTER 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitLocationFilter(long nAPIHandle, LOCATION_FILTER* pLocationFilter )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pLocationFilter - 指向要使用缺省值来初始化的 LOCATION_FILTER 结构。


InitNotification

说明

InitNotification 将 NOTIFICATION 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitNotification(long nAPIHandle, NOTIFICATION* pNotification )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pNotification - 指向要使用缺省值来初始化的 NOTIFICATION 结构。


InitProblemClosure

说明

InitProblemClosure 将 PROBLEM_CLOSURE 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitProblemClosure(long nAPIHandle, PROBLEM_CLOSURE* pProblemClosure )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pProblemClosure - 指向要使用缺省值来初始化的 PROBLEM_CLOSURE 结构。


InitProblemFilter

说明

InitProblemFilter 将 PROBLEM_FILTER 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitProblemFilter(long nAPIHandle, PROBLEM_FILTER* pProblemFilter )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pProblemFilter - 指向要使用缺省值来初始化的 PROBLEM_FILTER 结构。


InitProblemViewFilter

说明

InitProblemViewFilter 将 PROBVIEW_FILTER 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitProblemViewFilter (long nAPIHandle, PROBVIEW_FILTER* pProbViewFilter)

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pProbViewFilter - 指向要使用缺省值来初始化的 ROBVIEW_FILTER 结构。


InitRequestContext

说明

InitRequestContext 将 REQUEST_CONTEXT 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitRequestContext(long nAPIHandle, REQUEST_CONTEXT* pRequestContext )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pRequestContext - 指向要使用缺省值来初始化的 REQUEST_CONTEXT 结构。


InitSCIMKey

说明

InitSCIMKey 将 SCIM_KEY 数据成员设置为缺省值,以显示未使用的字段。

语法

void InitSCIMKey(long nAPIHandle, SCIM_KEY* pSCIMKey )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pSCIMKey - 指向要使用缺省值来初始化的 SCIM_KEY 结构。


InquireContacts

说明

InquireContacts 从数据库取装一个满足过滤标准的联系人列表。

注:数据库检索的项目不会多于指定的最大数。

语法

int InquireContacts(long nAPIHandle, const CONTACT_FILTER* pcontact_filter,
CONTACT_RECORD** ppContactList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pContactFilter - 用于过滤联系人的标准。

ppLocationList - 在返回时,列出与过滤器标准相匹配的联系人记录。

pnMaxRequested - 在初始呼叫时,指定要检索的记录的最大数目。在返回时,在 ppContactList 中指定记录的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


InquireLocations

说明

InquireLocations 从数据库取装一个满足 LOCATION_FILTER 中的过滤标准的场所列表。

注:数据库检索的项目不会多于指定的最大数。

语法

int InquireLocations(long nAPIHandle, const LOCATION_FILTER* pLocationFilter,
LOCATION_RECORD** ppLocationList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pContactFilter - 用于过滤联系人的标准。

ppLocationList - 在返回时,列出与过滤器标准相匹配的场所记录。

pnMaxRequested - 在初始呼叫时,指定要检索的记录的最大数目。在返回时,在 ppLocationList 中指定记录的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


InquireProblemViews

说明

InquireProblemViews 取装一个满足过滤标准的问题视图结构列表。

语法

int InquireProblemViews (long nAPIHandle, const PROBVIEW_FILTER* pProbViewFilter,
PROBVIEW_RECORD** ppProbViewList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL)

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pProbViewFilter - PROBVIEW_FILTER 记录,说明用于检索问题视图列表的搜索标准。

ppProbViewList - 在返回时,列出与过滤器标准相匹配的问题视图记录。

pnMaxRequested - 在初始呼叫时,指定要检索的问题视图的最大数目。在返回时,在 ppProbViewList 中指定问题的实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


InquireRequests

说明

InquireRequests 取装一个满足过滤标准的请求结构列表。

注:数据库检索的项目不会多于指定的最大数。

语法

int InquireRequests(long nAPIHandle, const PROBLEM_FILTER* pProblemFilter,
PROBLEM_RECORD** ppProblemList, long* pnMaxRequested, long* pnError,
const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pProblemFilter - PROBLEM_FILTER 记录,说明用于检索请求列表的搜索标准。

ppProblemList - 在返回时,列出与过滤器标准相匹配的请求记录。

pnMaxRequested - 在初始呼叫时,指定要检索的请求的最大数目。在返回时,在 ppProblemList 中指定请求实际数目。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


MakeDate

说明

用户给定一个有效日期(表示日、月和年的三个有序数字),MakeDate 在 C API 结构的日期字段中设置一个 ISO 标准日期格式。

语法

void MakeDate(char dateBuffer, int nMonth, int nDay, int nYear)

自变量

dateBuffer - 在返回时,指向包含已设置格式的 ISO 日期的已分配内存。

nMonth - ISO 日期中的月(1-12)

nDay - ISO 日期中的日(1-31)

nYear - ISO 日期中的年(0-9999)

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


SendNotification

说明

SendNotification 使用缺省的通知方法来发送通知。

语法

int SendNotification(long nAPIHandle, const NOTIFICATION* pNotification,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pNotification - 对要发送的通知进行说明的 NOTIFICATION 记录。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


TransferRequest

说明

TransferRequest 将请求传送给指定的用户或组。

语法

int TransferRequest(long nAPIHandle, char* pszRequestID, PROBLEM_CLOSURE* pProblem,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL)

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pProblem - PROBLEM_CLOSURE 记录,说明需要的传送信息。

szRequestID - 要传送的请求标识。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


UpdateRequest

说明

UpdateRequest 更新使用新信息指定的请求。

语法

int UpdateRequest(long nAPIHandle, char*pszRequestID, PROBLEM_CLOSURE* pProblem,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pProblem - PROBLEM_CLOSURE 记录,说明对请求的更新。

szRequestID - 要更新的请求标识。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。


LockProblem

说明

LockProblem 通过设置 PROBLEMS 表中的 ACTIVE_WITH 列来锁定 TSD 问题记录,从而防止对同一问题的并发更新。这种锁定是应用程序级的锁定,实际上并不锁定数据库表。

语法

int LockProblem( long nAPIHandle, const char* pszUserID, const char* pszProblemID,
long* pnError, const EXTENDED_DATA* pUserDefinedData = NULL )

自变量

nAPIHandle - 在对 Connect 的调用中初始化的 C API 句柄。

pszUserID - 要使用它来锁定问题的用户标识。这必须是一个有效的 TSD 用户。

pszProblemID - 要锁定的问题记录。

pnError - 如果出现错误,则该变量包含 SQL 错误号码。

pUserDefinedData - 列出要传送给该 C API 调用的可选参数。该用户定义数据可用于定制 C API 和应用程序服务器。

返回

int - 请求状态,可以是表示无错误的 SAI_OK,或表示已出现错误的 SAI_SQL_ERROR 或 SAI_ERROR。如果出现 SQL 错误,请使用 pnError 并参阅数据库手册。