lineGetAgentSessionList 函式 (tapi.h)

發行項
08/26/2023

lineGetAgentSessionList函式會傳回為指定代理程式建立的代理程式會話清單。它會產生要傳送至已註冊 Proxy 函式處理常式的LINE_PROXYREQUEST 訊息，參考類型為 LINEPROXYREQUEST_GETAGENTSESSIONLIST 的 LINEPROXYREQUEST 結構。

語法

LONG lineGetAgentSessionList(
  HLINE                  hLine,
  HAGENT                 hAgent,
  LPLINEAGENTSESSIONLIST lpAgentSessionList
);

參數

hLine

線條裝置的控制碼。

hAgent

要擷取其資訊的代理程式識別碼。

lpAgentSessionList

LINEAGENTSESSIONLIST類型的可變大小結構指標。成功完成要求時，此結構會填入為此代理程式建立的代理程式會話清單。在呼叫 lineGetAgentSessionList 函式之前，應用程式必須設定此結構的 dwTotalSize 成員，以指出 TAPI 可用來傳回信息的記憶體數量。

注意如果結構中的大小參數不正確，可能會覆寫記憶體。如需設定結構大小的詳細資訊，請參閱記憶體配置主題。

傳回值

如果非同步作業啟動時，會傳回要求識別碼;否則，函式會傳回下列其中一個錯誤值：

LINEERR_INVALLINEHANDLE、LINEERR_INVALPARAM、LINEERR_NOMEM、LINEERR_OPERATIONFAILED、LINEERR_OPERATIONUNAVAIL、LINEERR_RESOURCEUNAVAIL LINEERR_UNINITIALIZED。