Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Recupera o valor de uma "chave" na "Tabela X" de uma determinada sessão, e faz bloqueio da "chave" <cChave>.

Sintaxe

 

Bloco de código
titleVarGetX
lRet := VarGetXDVarGetX( <cUID>, <cChave>, <xValor> )

Parâmetros

NomeTipoDescriçãoObrigatórioReferênciaObservações
cUIDCaractere

Identificador da sessão de Variáveis Globais

X  
cChaveCaractereIdentificador da chaveX  
xValorNumérico / Caractere / Data / LógicoValor a ser armazenadoVariável onde será armazenado o valor da chaveXX 

Retorno

NomeTipoDescriçãoObservações
lRetLógico

Indica se conseguiu recuperar o valor da chave <cChave> na sessão <cUID> 

Retorna .T. se a função foi executada corretamente e se houver algum erro retorna .F.
 

Observações

Se a chave <cChave> ou a sessão <cUID> não existirem, será retornado .F. em <lRet> e o conteúdo de <xValor> é indefinido, se ambos forem encontrados <xValor> receberá uma cópia do valor armazenado.

Como esta função faz o bloqueio da chave não deve ser usada dentro de transações ("VarBeginT" na chave <cChave>).

Todavia se você só quiser recuperar o valor somente após o término de uma transação, esta função só irá executar após o término efetivo da transação ("VarEndT" na chave <cChave>).

Por conta de fazer bloqueio na chave esta função é mais lenta que a função "VarGetXD".

(aviso) Disponível em Build igual ou superior a 7.00.131227A

Exemplos

Exemplo 
Toggle Cloak
exclusivetrue

Cloak
visibletrue
true

Veja também

VarSetUIDVarSetXVarGetXD