TOTVSTEC

Árvore de páginas

Cria uma variável global para armazenar um único valor do tipo string e armazena a string de conteúdo fornecida.

Sintaxe

PutGlbValue( < cGlbName >, < cValue > )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cGlbName

caractere

Indica o nome da variável global a ser criada.

X


cValue

caractere

Indica a string de conteúdo a ser armazenado na variável global.

X


Observações

  • Uma variável global criada pela função PutGlbValue() somente recebe uma string como conteúdo;
  • Somente é possível recuperar o valor atribuído a uma variável global criada pela função PutGlbValue() através da função GetGlbValue();
  • Para criar variáveis globais capazes de armazenar conteúdos de outros tipos de dados, deve-se utilizar a função PutGlbVars();
  • 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

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

Abrangência

Microsiga Protheus 8.11 , Protheus 10, Protheus 11

Veja também

  • Sem rótulos