Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ UI Configuration Management Objects/ Obtaining the Window Handle List
Updated on 2024-07-30 GMT+08:00
View PDF
Share

Obtaining the Window Handle List

Function

This API is used to obtain the window handle list.

Function Prototype

getRenderWindowInfoList(onGetRenderWindowInfoListResult?: (ret: SDKERR, reason: string, hwndInfo: HwndListInfo) => void): voidgetRenderWindowInfoList(onGetRenderWindowInfoListResult?: (ret: SDKERR, reason: string, hwndInfo: HwndListInfo) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
onGetRenderWindowInfoListResult Yes (ret: SDKERR, reason: string, hwndInfo: HwndListInfo) => void Callback of the window handle list, which is returned for GetRenderWindowInfoList requests.

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string, hwndInfo: HwndListInfo) => void

Table 2 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.
hwndInfo HwndListInfo Window handle information.
Table 3 HwndListInfo
Parameter Type Description
hwndInfoList HwndInfo Video window handle list.
hwndListLength number Number of window handles in the list.