Saltar para o conteúdo principal
Versão: Próximo

ST GET OPTIONS

ST GET OPTIONS ( {* ;} objeto ; opcao ; valor {; opcao2 ; valor2 ; ... ; opcaoN ; valorN} )

ParâmetroTipoDescrição
*OperadorSe especificado, objeto é um nome de objeto (cadeia) Se omitido, objeto é um campo ou uma variável
objetoanyNome de objeto (se * for especificado) ou
Campo ou variável (se * for omitido)
opcaoIntegerOpção a ler
valorIntegerValor atual da opção

Esse comando não é seguro para thread e não pode ser usado em código adequado.

Descrição

O comando ST GET OPTIONS obtém o valor atual de uma ou várias opções de funcionamento do campo ou da variável de texto com estilo designada pelo parâmetro objeto.

Se passar o parâmetro opcional * indica que o parâmetro objeto é um nome de objeto (cadeia). Durante a execução, se o objeto tem o foco, o comando devolve a informação do objeto que se está editando, e se o objeto não tem o foco, o comando devolve a informação da fonte de dados do objeto (variável ou campo).
Se omitir o parâmetro *, indica que o parâmetro objeto é um campo ou uma variável. Neste caso, se passar uma referência de campo ou variável no lugar de uma cadeia. Durante a execução, o comando devolve a informação da variável ou do campo.

Passe o código da opção a ler no parâmetro opcao. O comando devolve em valor o atual da opção. Para ambos parâmetros, pode utilizar as seguintes constantes, que se encontram no tema "Texto multi estilo":

ConstanteTipoValorComentário
ST Expressions display modeInteiro longo1O parâmetro valor pode conter ST Values ou ST References
ST ReferencesInteiro longo1Mostra as cadeias fonte das expressões
ST ValuesInteiro longo0Mostra os valores calculados das expressões

Ver também

ST SET OPTIONS