TOTVSTEC

Árvore de páginas

Retorna a string armazenada em uma variável global.

Sintaxe

GetGlbValue( < cGlbName > )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cGlbName

caractere

Indica o nome da variável global.

X


Retorno

Nome

Tipo

Descrição

cValue

caractere

Retorna o valor da variável global especificada no parâmetro cGlbName. Caso a variável não seja encontrada, retorna um caracter vazio.

Observações

  • Uma variável global acessada pela função GetGlbValue() somente retorna uma string como conteúdo;
  • Somente é possível recuperar através da função GetGlbValue() o valor atribuído a uma variável global criada pela função PutGlbValue();
  • Para recuperar o conteúdo de variáveis globais criadas via PutGlbVars(), capazes de armazenar valores de tipos diversos, deve-se utilizar a função GetGlbVars();
  • O escopo de uma variável global é a instância do serviço do Protheus Server que está executando a aplicação AdvPL. Assim, devido ao escopo não se restringir ao ambiente (Environment) ou ao processo (Thread) do programa AdvPL que criou a variável global, seu conteúdo somente será eliminado da memória mediante a chamada da função ClearGlbValue(), ou após a finalização de todos os programas AdvPL em execução na instância do Protheus Server onde a variável global foi criada.

Exemplos

//Neste exemplo, será demonstrado como criar, utilizar e limpar variáveis globais
User Function teste()
  cGlbName  := "TPL_GLBVALUE"
  cGlbValue := ""
  // Alimenta variável
  PutGlbValue(cGlbName,"Teste")
  // Verifica o valor da variável
  cGlbValue := GetGlbValue(cGlbName)
  // Limpa variável
  if Trim(cGlbValue) <> ""
    ClearGlbValue(cGlbName)
  endif
return nil

Abrangência

Microsiga Protheus 8.11 , Protheus 10

Veja também

  • Sem rótulos