Árvore de páginas

Remove o valor de uma chave na "Tabela X"

Sintaxe

 

VarDelX
lRet := VarDelX( <cUID>, <cChave> )

Parâmetros

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

Identificador da sessão de Variáveis Globais

X  
cChaveCaractereIdentificador da chaveX  

Retorno

NomeTipoDescriçãoObservações
lRetLógico

Indica se conseguiu remover 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

Para fazer a remoção do valor esta função faz o bloqueio da chave, com isto se houver alguma transação em curso ("VarBeginT" na chave <cChave>), esta função irá aguardar o término da transação ("VarEndT" na chave <cChave>) para executar.

Quando possível, dê preferência para usar VarDel, mesmo que se tenha adcionado valores somente na "Tabelas X" com VarSetX ou VarSetXD, pois esta função VarDel elimina o valor e a transação da chave.

Para deleção completa da chave e da transação da chave veja VarDel.

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

Exemplos

Exemplo 

User Function exemplo()
  Local cMyUID := "teste_UID_RL"
  Local cChave := "chave"
  Local lRet := .F.
   
  lRet := VarSetUID(cMyUID, .T.)
  If(!lRet)
    ConOut("Erro na criação da sessão: " + cMyUID)
  EndIf
  
  lRet := VarDelX(cMyUID, cChave)
  If(!lRet)
    ConOut("Erro na deleção da chave: " + cChave)
  Else
    ConOut("Deletou a chave: " + cChave)
  EndIf
Return .T.
  • Sem rótulos