Função: HMKey
HMKeyObtem 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_N >, < nTrim_N > ) --> cKey |
| Parâmetros | | | Nome | Tipo | Descrição | Obrigatório | Referência | aArray | Array | Linha com os elementos que participaram da chave de busca | X | | nColuna_N | Numérico | Indica o número da coluna que será usada contem o valor da chave a ser inserida | | | nTrim_N | Numérico | Tipo de Trim para colunas de “Caracter” (palavras) | | |
| Retorno | | | Nome | Tipo | Descrição | cKey | Caracter | 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. | Exemplo | | | … Local lRet := nil Local oVal := nil Local cKey := HMKey({“ col1 ”, “ col2 ”, 7, “ col 4 ”}, 2, 3, 1, 0, 3, 0) lRet := HMGet(oHash, cKey, oVal) If (lRet != .T.) conout("Valor nao encontrado") Endif … |
|
|
|
Abrangência
Protheus 11 com release superior a 7.00.121227P
Veja Também
HMGet , HMSet , HMDel , AToHM , Manipulação de matriz (HashMap)