跳至主要内容

函数:showInputBox()

showInputBox(options?, token?): Promise<string | undefined>

打开一个输入框,要求用户输入。

如果输入框被取消(例如按 ESC),则返回值将为 undefined。否则,返回值将是用户输入的字符串,如果用户没有输入任何内容但用 OK 关闭了输入框,则返回值为空字符串。

参数

options?: InputBoxOptions

配置输入框的行为。

token?: CancellationToken

一个可用于发出取消信号的令牌。

返回值

Promise<string | undefined>

一个承诺,解析为用户提供的字符串或在取消的情况下为 undefined

定义在

packages/extension-api/src/extension-api.d.ts:2249