Class: OSApplication

@nginstack/engine/lib/os/OSApplication~ OSApplication


new OSApplication(command)

O protótipo OSApplication representar uma aplicação do Sistema Operacional. Ela pode ser usada para criar e matar processos.

Parameters:
Name Type Description
command string

Caminho do executável. Caso o executável esteja no PATH do sistema não é necessário informar o caminho completo.

Members


<static> HIDE

Constante para ser usada no parâmetro 'commandShow' do método start(parameters, commandShow). Esta constante indica que a janela da aplicação ficará oculta quando a aplicação estiver sendo executada.


<static> INFINITE_TIMEOUT

Constante para ser usada no parâmetro 'timeout' do método waitFor(timeout). Se esta constante for informada, a execução da próxima instrução, que vem logo após a chamada do método waitFor(timeout), só irá ocorrer quando a a aplicação for finalizada.


<static> MAXIMIZE

Constante para ser usada no parâmetro 'commandShow' do método start(parameters, commandShow). Esta constante indica que a janela da aplicação será aberta de forma maximizada quando a aplicação for executada.


<static> MINIMIZE

Constante para ser usada no parâmetro 'commandShow' do método start(parameters, commandShow). Esta constante indica que a janela da aplicação será aberta de forma minimizada quando a aplicação for executada.


<static> SHOW

Constante para ser usada no parâmetro 'commandShow' do método start(parameters, commandShow). Esta constante indica que a janela da aplicação será exibida.


workingDirectory

Caminho do diretório de trabalho da aplicação.

Methods


<static> startDetached(command, parameters, workingDirectory)

Executa a aplicação de forma assíncrona. Usando o método estático a aplicação não depende da instância de OSApplication, sendo preferível este uso. Em caso de falha, o valor de retorno será 'undefined'.

Parameters:
Name Type Description
command string

Caminho do executável. Caso o executável esteja no PATH do sistema não é necessário informar o caminho completo.

parameters string

Parâmetros usados para executar a aplicação. Informe de maneira semelhante ao chamar via prompt do DOS, usando "(aspas) para parâmetros com espaço.

workingDirectory string

Caminho do diretório de trabalho da aplicação.

See:
  • OSApplication#startDetached
Returns:

Número identificador do processo.

Type
number

getExitCode()

Obtém o código de erro retornado pela aplicação ao ser finalizada. Caso a aplicação esteja em execução ou nunca foi executada será retornado 'undefined'.

Returns:

código de erro retornado pela aplicação.

Type
number

getIsRunning()

Indica se a aplicação está sendo executada.

Returns:

Retorna "true" para indicar que a aplicação está em execução, retorna "false", caso contrário.

Type
boolean

getLastErrorCode()

Caso haja algum erro na execução da aplicação, o valor dessa propriedade será o código do último erro ocorrido. Caso a aplicação esteja em execução ou nunca foi executada, o valor retornado será '0'.

Returns:

código de erro retornado pela aplicação.

Type
number

getPid()

Identificador do processo. Caso o a aplicação não esteja sendo executada o valor desta propriedade será 'undefined'.

Returns:

Número identificador do processo.

Type
number

redirectStdErrorOutput(outputErrorFileName)

Redireciona a saída padrão de erros da aplicação em execução para arquivos.

Parameters:
Name Type Description
outputErrorFileName string

Nome do arquivo que será utilizado como saída padrão de erro da aplicação.


redirectStdInput(inputFileName)

Redireciona a entrada padrão da aplicação em execução para arquivos. Seria o equivalente ao executar: programa.exe < entrada.txt

Parameters:
Name Type Description
inputFileName string

Nome do arquivo que será utilizado como entrada padrão para a aplicação.


redirectStdOutput(outputFileName)

Redireciona a saída padrão da aplicação em execução para arquivos. Seria o equivalente ao executar: programa.exe > saída.txt

Parameters:
Name Type Description
outputFileName string

Nome do arquivo que será utilizado como saída padrão para a aplicação.


start(parameters, commandShow)

Executa a aplicação de forma assíncrona. A aplicação será finalizada se não houver mais referências a esta instância de OSApplication ou se a sessão do usuário for finalizada. Utilize o método #waitFor se desejar aguardar a conclusão da execução da aplicação.

Parameters:
Name Type Description
parameters string

Parâmetros usados para executar a aplicação. Informe de maneira semelhante ao chamar via prompt do DOS, usando "(aspas) para parâmetros com espaço.

commandShow string

Indica a forma de como a janela a aplicação será mostrada ao ser executada. Os possíveis valores são: OSApplication.SHOW, OSApplication.HIDE, OSApplication.MINIMIZE e OSApplication.MAXIMIZE.

See:
Returns:

Retorna "true", caso a execução da aplicação for bem sucedida. Retorna "false", caso contrário.

Type
boolean

startDetached()

A criação de um processo desatachado não é mais suportado por este método, sendo o comportamento atual equivalente a chamar o método #start. Utilize OSApplication.startDetached caso necessite criar um processo desatachado.

Deprecated:
  • Utilize o método estático OSApplication.startDetached.
See:

terminate( [opt_timeout])

Finaliza a execução da aplicação.

Parameters:
Name Type Argument Description
opt_timeout number <optional>

Tempo limite para a aplicação ser finalizada. Ao finalizar uma aplicação, ela precisa liberar os recursos que ela aloca. Ao executar o este método é dado um tempo máximo para aplicação liberar os recursos, caso o tempo máximo seja excedido a aplicação será fechada de forma forçada. O valor default do tempo máximo para fechamento da aplicação é 10segundos. O valor informado para o parâmetro timeout deve ser informado em milissegundos.

Returns:

Retorna "true", caso a aplicação seja finalizada dentro do tempo limite especificado. Retorna "false", caso contrário.

Type
boolean

waitFor( [opt_timeout])

Aguarda a aplicação ser finalizada. Ao chamar este método, o próximo comando não é executado até que a aplicação seja fechada ou exceda o tempo máximo de espera informado.

Parameters:
Name Type Argument Description
opt_timeout number <optional>

Tempo máximo de espera para que a aplicação seja fechada. Se a constante OSApplication.INFINITE_TIMEOUT for informada para este parâmetro ou este parâmetro for omitido, o método waitFor irá esperar que aplicação seja fechada.

Returns:

Retorna "true", caso a aplicação seja fechada dentro do tempo limite especificado. Retorna "false", caso contrário.

Type
boolean