TOTVSTEC

Árvore de páginas

Obtem o valor de chave simples ou composta a partir das colunas eleitas de um array. A chave obtida poderá ser usada nas funções: HMGet, HMSet, HMDel.

Sintaxe

HMKey( < aArray >, [ nColuna_1 ], [ n_Trim_1 ], [ nColuna_N ], [ n_Trim_N ] )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

aArray

vetor

Linha com os elementos que participaram da chave de busca

X

 

nColuna_1

numérico

Indica o número da coluna que contem o valor da chave a ser inserida

 

 

n_Trim_1

numérico

Tipo de Trim para colunas de caractere

 

 

nColuna_N

numérico

Informar mais de uma coluna se necessário (máximo 8)

 

 

n_Trim_N

numérico

Tipo de Trim para as colunas do tipo caractere.

 

 

Retorno

Nome

Tipo

Descrição

cKey

caractere

Palavra contendo a chave de busca referente às colunas

Observações

  • O valor de “N” varia de 0 (zero) até 8 colunas para serem combinadas na chave de busca.
  • Se nenhuma coluna for adicionada (“N” = 0), usa por padrão a primeira coluna (“nColuna” = 1) e sem trim (“nTrim” = 0).
  • Os valores de “nTrim” podem ser: 0 – não altera a palavra, 1 – Elimina espaços a esquerda, 2 – Elimina espaços a direita, 3 – Elimina espaços a esquerda e a direita.
  • Se o valor de ”nTrim” não for fornecido, considera que não deve eliminar espaços da palavra (“nTrim” = 0).
  • É recomendado que se utilize o “HMKey“ somente para obter chaves compostas, ou seja, que contenham mais de uma coluna na sua formação, pois para chaves simples (uma coluna), basta passar a variável para a inserção/busca.

Exemplos

Exemplo 1
User Function exemplo()
  Local oVal := nil
  lista := {}
  AAdd(lista, {"item1",23})
  AAdd(lista, {"item2",104})
  AAdd(lista, {"item3",41})
  AAdd(lista, {"item4",1})
  AAdd(lista, {"item5",18})
  oHash := AToHM(lista,1,3,2,3)
  
  cKey := HMKey({"item2",104},1,3,2,3)
  lRet := HMGet(oHash,cKey,oVal)
  if lRet == .T.
    varinfo("Lista",oVal)
  endif 
Return

Abrangência

Totvs Application Server com versão igual ou superior a 7.00.131227A

Veja também

  • Sem rótulos