tapi.h (LINECALLINFO 結構)

發行項
03/02/2024

LINECALLINFO 結構包含呼叫的相關信息。在呼叫期間，這項資訊會維持相對固定的狀態。多個函式使用 LINECALLINFO。結構是由 lineGetCallInfo 函式和 TSPI_lineGetCallInfo 函式傳回。如果結構的一部分確實變更，則會將 LINE_CALLINFO 訊息傳送至應用程式，指出哪些資訊專案已變更。

動態變更呼叫的相關信息，例如呼叫進度狀態，可在 LINECALLSTATUS 結構中使用，由 lineGetCallStatus 函式呼叫傳回。

語法

typedef struct linecallinfo_tag {
  DWORD          dwTotalSize;
  DWORD          dwNeededSize;
  DWORD          dwUsedSize;
  HLINE          hLine;
  DWORD          dwLineDeviceID;
  DWORD          dwAddressID;
  DWORD          dwBearerMode;
  DWORD          dwRate;
  DWORD          dwMediaMode;
  DWORD          dwAppSpecific;
  DWORD          dwCallID;
  DWORD          dwRelatedCallID;
  DWORD          dwCallParamFlags;
  DWORD          dwCallStates;
  DWORD          dwMonitorDigitModes;
  DWORD          dwMonitorMediaModes;
  LINEDIALPARAMS DialParams;
  DWORD          dwOrigin;
  DWORD          dwReason;
  DWORD          dwCompletionID;
  DWORD          dwNumOwners;
  DWORD          dwNumMonitors;
  DWORD          dwCountryCode;
  DWORD          dwTrunk;
  DWORD          dwCallerIDFlags;
  DWORD          dwCallerIDSize;
  DWORD          dwCallerIDOffset;
  DWORD          dwCallerIDNameSize;
  DWORD          dwCallerIDNameOffset;
  DWORD          dwCalledIDFlags;
  DWORD          dwCalledIDSize;
  DWORD          dwCalledIDOffset;
  DWORD          dwCalledIDNameSize;
  DWORD          dwCalledIDNameOffset;
  DWORD          dwConnectedIDFlags;
  DWORD          dwConnectedIDSize;
  DWORD          dwConnectedIDOffset;
  DWORD          dwConnectedIDNameSize;
  DWORD          dwConnectedIDNameOffset;
  DWORD          dwRedirectionIDFlags;
  DWORD          dwRedirectionIDSize;
  DWORD          dwRedirectionIDOffset;
  DWORD          dwRedirectionIDNameSize;
  DWORD          dwRedirectionIDNameOffset;
  DWORD          dwRedirectingIDFlags;
  DWORD          dwRedirectingIDSize;
  DWORD          dwRedirectingIDOffset;
  DWORD          dwRedirectingIDNameSize;
  DWORD          dwRedirectingIDNameOffset;
  DWORD          dwAppNameSize;
  DWORD          dwAppNameOffset;
  DWORD          dwDisplayableAddressSize;
  DWORD          dwDisplayableAddressOffset;
  DWORD          dwCalledPartySize;
  DWORD          dwCalledPartyOffset;
  DWORD          dwCommentSize;
  DWORD          dwCommentOffset;
  DWORD          dwDisplaySize;
  DWORD          dwDisplayOffset;
  DWORD          dwUserUserInfoSize;
  DWORD          dwUserUserInfoOffset;
  DWORD          dwHighLevelCompSize;
  DWORD          dwHighLevelCompOffset;
  DWORD          dwLowLevelCompSize;
  DWORD          dwLowLevelCompOffset;
  DWORD          dwChargingInfoSize;
  DWORD          dwChargingInfoOffset;
  DWORD          dwTerminalModesSize;
  DWORD          dwTerminalModesOffset;
  DWORD          dwDevSpecificSize;
  DWORD          dwDevSpecificOffset;
  DWORD          dwCallTreatment;
  DWORD          dwCallDataSize;
  DWORD          dwCallDataOffset;
  DWORD          dwSendingFlowspecSize;
  DWORD          dwSendingFlowspecOffset;
  DWORD          dwReceivingFlowspecSize;
  DWORD          dwReceivingFlowspecOffset;
  DWORD          dwCallerIDAddressType;
  DWORD          dwCalledIDAddressType;
  DWORD          dwConnectedIDAddressType;
  DWORD          dwRedirectionIDAddressType;
  DWORD          dwRedirectingIDAddressType;
} LINECALLINFO, *LPLINECALLINFO;

成員

dwTotalSize

配置給這個數據結構的大小總計，以位元組為單位。

dwNeededSize

此數據結構的大小，需要以位元組為單位來保存所有傳回的資訊。

dwUsedSize

包含實用資訊的這個數據結構部分大小，以位元組為單位。

hLine

處理與此呼叫相關聯的行裝置。

dwLineDeviceID

與此呼叫相關聯之線路裝置的裝置標識碼。

dwAddressID

此呼叫所在行的位址識別碼。位址標識符會永久與地址相關聯;標識碼在操作系統升級期間會維持不變。

dwBearerMode

呼叫的目前持有人模式。這個成員會使用其中一個 LINEBEARERMODE_常數。

dwRate

呼叫數據流的速率，以 bps (每秒) 位為單位。

dwMediaMode

目前在呼叫上的資訊數據串流媒體類型。這是由呼叫擁有者所決定的媒體類型，這不一定與最後一個LINE_MONITORMEDIA 訊息的相同。此成員不會受到LINE_MONITORMEDIA訊息直接影響。這個成員會使用 LINEMEDIAMODE_常數。

dwAppSpecific

API 實作和服務提供者未解譯。此呼叫的任何擁有者應用程式都可以使用 lineSetAppSpecific 函式來設定。

dwCallID

在某些電話語音環境中，交換器或服務提供者可以將唯一標識符指派給每個通話。這可讓呼叫跨傳輸、轉寄或其他事件進行追蹤。這些呼叫標識碼的網域及其範圍是服務提供者定義的。 dwCallID 成員可讓應用程式使用此唯一標識符。

dwRelatedCallID

使用通話標識碼的電話語音環境通常可能會發現需要讓一個通話與另一個通話產生關聯。服務提供者可能會針對此目的使用 dwRelatedCallID 成員。

dwCallParamFlags

當呼叫傳出時，呼叫相關參數的集合。這些是 lineMakeCall中指定的相同呼叫參數，其中一或多個 LINECALLPARAMFLAGS_常數。

dwCallStates

一或多個LINECALLSTATE_常數，指出應用程式在此呼叫時可以通知的狀態。 dwCallStates 成員在 LINECALLINFO 中是常數，而且不會根據呼叫狀態而變更。

dwMonitorDigitModes

各種數位模式。此成員是目前啟用監視的一或多個 LINEDIGITMODE_常數。

dwMonitorMediaModes

目前啟用監視的各種媒體類型。這個成員是一或多個 LINEMEDIAMODE_常數。

DialParams

目前對 LINEDIALPARAMS 類型的呼叫生效的撥號參數。除非這些參數是由 lineMakeCall 或 lineSetCallParams所設定，否則其值會與 LINEDEVCAPS 結構中使用的預設值相同。

dwOrigin

識別呼叫的來源。這個成員可以是其中一個 LINECALLORIGIN_常數。

dwReason

發生呼叫的原因。這個成員可以是其中一個 LINECALLREASON_常數。

dwCompletionID

如果傳入呼叫的完成識別碼是終止完成要求的結果，則為。只有當 dwReason 是LINECALLREASON_CALLCOMPLETION時，此標識碼才有意義。

dwNumOwners

具有呼叫擁有者許可權之不同呼叫句柄的應用程式模組數目。

dwNumMonitors

具有不同呼叫句柄的應用程式模組數目，具有呼叫的監視許可權。

dwCountryCode

目的地合作對象的國家或地區代碼。如果未知，則為零。

dwTrunk

路由呼叫的主幹編號。此成員同時用於傳入和傳出通話。 如果未知，dwTrunk 成員應該設定為 0xFFFFFFFF。

dwCallerIDFlags

決定呼叫端或來源者合作對象標識碼資訊的有效性和內容。這個成員會使用其中一個 LINECALLPARTYID_常數。

dwCallerIDSize

呼叫端標識碼的大小，以位元組為單位。

dwCallerIDOffset

從這個結構的開頭位移到包含呼叫端標識碼資訊的可變大小欄位。欄位的大小是由 dwCallerIDSize 所指定。

dwCallerIDNameSize

呼叫端標識碼名稱的大小，包括 Null 終止符，以位元組為單位。

dwCallerIDNameOffset

從這個結構的開頭位移至包含呼叫端標識碼名稱資訊的可變大小欄位。欄位的大小是由 dwCallerIDNameSize 所指定。

dwCalledIDFlags

決定被呼叫者標識符資訊的有效性和內容。被呼叫者會對應至原先尋址的合作物件。這個成員會使用其中一個 LINECALLPARTYID_常數。

dwCalledIDSize

呼叫方標識碼的大小，以位元組為單位。

dwCalledIDOffset

從結構的開頭位移至包含被呼叫方標識符資訊的可變大小字段。欄位的大小是由 dwCalledIDSize 所指定。

dwCalledIDNameSize

呼叫者標識碼名稱的大小，包括 null 終止符，以位元組為單位。

dwCalledIDNameOffset

從結構的開頭位移至包含被呼叫方標識碼名稱資訊的可變大小字段。欄位的大小是由 dwCalledIDNameSize 所指定。

dwConnectedIDFlags

決定連線者標識碼資訊的有效性和內容。連接的合作對像是實際連接的合作物件。如果呼叫已轉移，這可能與被呼叫者標識符不同。這個成員會使用其中一個 LINECALLPARTYID_常數。

dwConnectedIDSize

線上方識別碼的大小，以位元組為單位。

dwConnectedIDOffset

從這個結構的開頭位移至包含連接方標識符資訊的可變大小欄位。欄位的大小是由 dwConnectedIDSize 所指定。

dwConnectedIDNameSize

連線者識別碼名稱的大小，包括 Null 終止符，以位元組為單位。

dwConnectedIDNameOffset

從這個結構的開頭位移至包含連接方標識碼名稱資訊的可變大小欄位。欄位的大小是由 dwConnectedIDNameSize 所指定。

dwRedirectionIDFlags

決定重新導向物件標識碼資訊的有效性和內容。重新導向合作對象會識別會話重新導向的位址。這個成員會使用其中一個 LINECALLPARTYID_常數。

dwRedirectionIDSize

重新導向方標識碼的大小，以位元組為單位。

dwRedirectionIDOffset

從結構的開頭位移至包含重新導向方標識符資訊之可變大小的字段。欄位的大小是由 dwRedirectionIDSize 所指定。

dwRedirectionIDNameSize

重新導向方識別碼名稱的大小，以位元組為單位。

dwRedirectionIDNameOffset

從結構的開頭位移至包含重新導向方標識元名稱資訊的可變大小欄位。欄位的大小是由 dwRedirectionIDNameSize 所指定。

dwRedirectingIDFlags

決定重新導向者標識碼資訊的有效性和內容。重新導向者會識別重新導向會話的位址。這個成員會使用其中一個 LINECALLPARTYID_常數。

dwRedirectingIDSize

重新導向方標識碼的大小，以位元組為單位。

dwRedirectingIDOffset

從結構的開頭位移至包含重新導向合作對象標識碼資訊的可變大小字段。欄位的大小是由 dwRedirectingIDSize 所指定。

dwRedirectingIDNameSize

重新導向方標識碼名稱的大小，包括 null 終止符，以位元組為單位。

dwRedirectingIDNameOffset

從結構開頭位移至包含重新導向方標識元名稱資訊的可變大小欄位。欄位的大小是由 dwRedirectingIDNameSize 所指定。

dwAppNameSize

應用程式名稱欄位的大小，包括 null 終止符，以位元組為單位。

dwAppNameOffset

從結構的開頭位移到保留第一次產生、接受或接聽呼叫之應用程式的用戶易記名稱的可變大小欄位。這是應用程式可以在 lineInitializeEx中指定的名稱。如果應用程式未指定這類名稱，則會改用應用程式的模組檔名。欄位的大小是由 dwAppNameSize 所指定。

dwDisplayableAddressSize

可顯示位址字串的大小，包括 null 終止符，以位元組為單位。

dwDisplayableAddressOffset

可顯示字串用於記錄用途。起始呼叫的函式會從 LINECALLPARAMS 取得資訊。 lineTranslateAddress 函式會傳回要放置在 LINETRANSLATEOUTPUT 結構的 dwDisplayableAddressSize 和 dwDisplayableAddressOffset 成員中的適當資訊。

dwCalledPartySize

呼叫方描述欄位的大小，以位元組為單位。

dwCalledPartyOffset

從結構的開頭位移到指定呼叫方用戶易記描述的可變大小欄位。此資訊可以使用 lineMakeCall 來指定，而且可以在建立新的呼叫時選擇性地在 lpCallParams 參數中指定。它適用於呼叫記錄用途。欄位的大小是由 dwCalledPartySize 所指定。

dwCommentSize

批注欄位的大小，以位元組為單位。

dwCommentOffset

從結構開頭位移至可變大小的欄位，保留有關使用 lineMakeCall產生呼叫之應用程式所提供之呼叫的批注。每當建立新的呼叫時，可以在 lpCallParams 參數中選擇性地指定這項資訊。欄位的大小是由 dwCommentSize 所指定。

dwDisplaySize

原始顯示資訊的大小，以位元組為單位。

dwDisplayOffset

從結構開頭位移到保留原始顯示資訊的可變大小欄位。根據電話語音環境，服務提供者可能會從此成員組擷取功能資訊，以取得最適合此電話語音設定的格式和簡報。欄位的大小是由 dwDisplaySize 所指定。

dwUserUserInfoSize

用戶使用者資訊的大小，以位元組為單位。如果使用者資訊是字串的指標，大小必須包含 Null 終止符。

dwUserUserInfoOffset

從結構的開頭位移到保留用戶使用者資訊的可變大小欄位。如果使用的使用者資訊通訊協議辨別欄位會顯示為 dwUserUserUserInfoOffset 所指向之數據的第一個字節，而且會考慮 在 dwUserUserInfoSize 中。

dwHighLevelCompSize

高階相容性資訊的大小，以位元組為單位。

dwHighLevelCompOffset

從結構開頭位移至保留高階相容性資訊的可變大小字段。此資訊的格式是由 ISDN Q.931) 的其他標準 (所指定。欄位的大小是由 dwHighLevelCompSize 所指定。

dwLowLevelCompSize

低階相容性資訊的大小，以位元組為單位。

dwLowLevelCompOffset

從結構開頭位移至保留低階相容性資訊的可變大小字段。此資訊的格式是由 ISDN Q.931) 的其他標準 (所指定。欄位的大小是由 dwLowLevelCompSize 所指定。

dwChargingInfoSize

充電資訊的大小，以位元組為單位。

dwChargingInfoOffset

從結構開頭位移至保留充電資訊的可變大小欄位。此資訊的格式是由 ISDN Q.931) 的其他標準 (所指定。欄位的大小是由 dwChargingInfoSize 所指定。

dwTerminalModesSize

目前終端機模式陣列的大小，以位元組為單位。

dwTerminalModesOffset

從結構的開頭位移到包含 具有 DWORD 大小項目的數位的可變大小裝置欄位。數位專案會依終端機標識碼編製索引，範圍從零到小於 dwNumTerminals。數位中的每個專案都會針對這個呼叫的媒體數據流指定對應終端機集的目前終端機模式，如其中一個LINETERMMODE_常數所指定。陣列的大小是由 dwTerminalModesSize 所指定。

dwDevSpecificSize

裝置特定欄位的大小，以位元組為單位。

dwDevSpecificOffset

從結構的開頭位移到保留裝置特定資訊的可變大小欄位。欄位的大小是由 dwDevSpecificSize 所指定。

dwCallTreatment

目前在呼叫上套用的呼叫處理，或在呼叫進入下一個適用狀態時套用。如果不支援呼叫處理，則可為零。

dwCallDataSize

應用程式可設定呼叫數據的大小，以位元組為單位。

dwCallDataOffset

從結構的開頭位移至應用程式可設定的呼叫數據。欄位的大小是由 dwCallDataSize 所指定。

dwSendingFlowspecSize

服務品質資訊的大小，以位元組為單位。

dwSendingFlowspecOffset

從結構的開頭位移至 FLOWSPEC 結構，後面接著 WinSock 提供者特定數據，相當於 QOS 結構中將儲存在 SendingFlowspec 中的專案。指定目前在呼叫上傳送方向生效的服務品質。 FLOWSPEC 結構後面的提供者特定部分不得包含其他記憶體區塊的指標，因為TAPI不知道如何封送處理私人指標所指向的數據， () ，並透過進程間通訊與應用程式傳達。欄位的大小是由 dwSendingFlowspecSize 所指定。

dwReceivingFlowspecSize

服務品質資訊的大小，以位元組為單位。

dwReceivingFlowspecOffset

從結構的開頭位移至 FLOWSPEC 結構，後面接著 WinSock 提供者特定數據，相當於 QOS 結構中儲存在 ReceivingFlowspec 中的專案。指定目前在呼叫上接收方向生效的服務品質。 FLOWSPEC 結構後面的提供者特定部分不得包含其他記憶體區塊的指標，因為TAPI不知道如何封送處理私人指標所指向的數據， () ，並透過進程間通訊與應用程式傳達。欄位的大小是由 dwReceivingFlowspecSize 所指定。

dwCallerIDAddressType

呼叫端的地址類型。只有在交涉的 TAPI 版本為 3.0 或更高版本時，才能使用結構的成員。

dwCalledIDAddressType

所呼叫對象的地址類型。只有在交涉的 TAPI 版本為 3.0 或更高版本時，才能使用結構的成員。

dwConnectedIDAddressType

呼叫實際連接的目的地地址類型。只有在交涉的 TAPI 版本為 3.0 或更高版本時，才能使用結構的成員。

dwRedirectionIDAddressType

新呼叫目的地的地址類型。只有在交涉的 TAPI 版本為 3.0 或更高版本時，才能使用結構的成員。

dwRedirectingIDAddressType

重新導向呼叫的位置地址類型。只有在交涉的 TAPI 版本為 3.0 或更高版本時，才能使用結構的成員。

備註

裝置特定的延伸模組應該使用 DevSpecific (dwDevSpecificSize 和 dwDevSpecificOffset) 此數據結構的可變大小區域。

LINECALLINFO 數據結構包含有關呼叫的相對固定資訊。此結構會以 lineGetCallInfo傳回。當此資料結構中的資訊項目變更時，會將LINE_CALLINFO訊息傳送至應用程式。此訊息的參數是已變更的信息專案或欄位。

透過 dwReceivingFlowspecOffset 的成員 dwCallTreatment 只能供使用 API 版本為 2.0 或更新版本的應用程式使用。

注意指定 dwCallID 字段內容以及 dwCallerIDFlag、dwCallerIDSize、dwCallerIDSize、dwCallerIDOff) set、dwCallerIDNameSize 和 dwCallerIDNameOffset 的其他五個類似 (字段的慣用格式是 TAPI 標準數位格式。例如，從交換器收到的「4258828080」 ICLID 應該先轉換成「+1 (425) 8828080」，再放在 LINECALLINFO 結構中。這種標準化格式有助於搜尋應用程式中實作的資料庫和回呼函式。