函数

func atExit(() -> Unit)

public func atExit(callback: () -> Unit): Unit

功能:注册回调函数,当前进程退出时执行注册函数。

注意:

请不要使用 C 语言 atexit 函数,避免出现不可期问题。

参数:

  • callback: () ->Unit - 需要被注册回调的函数。

func exit(Int64)

public func exit(code: Int64): Nothing

功能:注册回调函数,当前进程退出时执行注册函数。

参数:

  • code: Int64 - 当前进程退出状态码。

func getCommand()

public func getCommand(): String

功能:获取进程命令。

返回值:

  • String - 当前进程命令。

异常:

  • EnvException - 当进程不存在或对应进程为僵尸进程,无法获取进程名时,抛出异常。

func getCommandLine()

public func getCommandLine(): Array<String>

功能:获取当前进程命令行。Windows 平台当前进程可获取,其他场景下无法在非特权 API 下获取到本属性,暂不支持获取。

返回值:

异常:

  • EnvException - 当进程不存在或对应进程为僵尸进程,或在 Windows 平台下暂不支持场景,无法获取进程命令行时,抛出异常。

func getHomeDirectory()

public func getHomeDirectory(): Path

功能:获取当前进程 home 目录的路径。

返回值:

  • Path - 当前进程 home 目录的路径。

func getProcessId()

public func getProcessId(): Int

功能:获取当前进程 id。

返回值:

  • Int - 当前进程 id。

func getStdErr()

public func getStdErr(): ConsoleWriter

功能:获取当前进程标准错误流。

返回值:

func getStdIn()

public func getStdIn(): ConsoleReader

功能:获取当前进程标准输入流。

返回值:

func getStdOut()

public func getStdOut(): ConsoleWriter

功能:获取当前进程标准输出流。

返回值:

func getTempDirectory()

public func getTempDirectory(): Path

功能:获取当前进程临时目录的路径。从环境变量中获取 TMPDIR、TMP、TEMP 和 TEMPDIR 环境变量。如果以上值在环境变量中均不存在,则默认返回 /tmp 目录。

返回值:

  • Path - 当前进程临时目录的路径。

func getVariable(String)

public func getVariable(key: String): ?String

功能:获取当前进程指定名称的环境变量值。

参数:

  • key: String - 指定名称。

返回值:

  • ?String - 当前进程指定名称的环境变量值。

异常:

func getVariables()

public func getVariables(): Array<(String, String)>

功能:获取当前进程环境变量。Windows 平台当前进程可获取,其他场景下无法在非特权 API 下获取到本属性,暂不支持获取。

返回值:

异常:

  • EnvException - 当进程不存在或对应进程为僵尸进程,或在 Windows 平台下暂不支持场景,无法获取进程环境变量时,抛出异常。

func getWorkingDirectory()

public func getWorkingDirectory(): Path

功能:获取当前进程工作路径。Windows 平台当前进程可获取,其他场景下无法在非特权 API 下获取到本属性,暂不支持获取。

返回值:

  • Path - 当前进程工作路径。

异常:

  • EnvException - 当进程不存在或对应进程为僵尸进程,或在 Windows 平台下暂不支持场景,无法获取进程工作路径时,抛出异常。

func removeVariable(String)

public func removeVariable(key: String): Unit

功能:通过指定环境变量名称移除环境变量。

参数:

  • key: String - 环境变量名称。

异常:

func setVariable(String, String)

public func setVariable(key: String, value: String): Unit

功能:用于设置一对环境变量。如果设置了同名环境变量,原始环境变量值将被覆盖。

说明:

Windows 下如果传入的参数 v 是空字符串,那么会从环境中移除变量 k。

参数:

  • key: String - 环境变量名称。
  • value: String - 环境变量值。

异常: