TOTVSTEC

Árvore de páginas

Verifica qual a expressão de chave da ordem.

Sintaxe

OrdKey( < cOrdem >, [ nPosicao ], [ cArqIndice ] )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cOrdem

caractere

Indica o nome do índice (Tag).

X


nPosicao

numérico

Indica a ordem numérica do índice.



cArqIndice

caractere

Indica o nome do arquivo de índice (Bagname).



Retorno

Nome

Tipo

Descrição

cRet

caractere

Retorna a expressão de chave da ordem ativa ou especificada pelos parâmetros. Se o retorno for uma string vazia, significa que não existe ordem corrente.

Observações

  • Essa função é utilizada para verificar qual é a expressão de chave de determinada ordem.
  • Caso os parâmetros de identificação da ordem não sejam especificados, será verificada a ordem corrente.
  • Para evitar conflito, se houver mais de uma ordem com o mesmo nome, pode-se passar o parâmetro com o nome do índice ao qual a ordem pertence.
  • A ordem passada, no primeiro parâmetro <nOrdem> ou <nPosicao>, pode ser especificada através da sua posição na lista de ordens ativas (através da OrdListAdd) ou do nome dado à ordem. Pois, a função verifica automaticamente se o parâmetro é numérico ou carácter.

Exemplos

user function example()
  Local cT1 := "T1"
  
  TCLink()
  
  DBCreate("T1", {{"FIELD_NAME", "C", 10, 0}, ;
                  {"FIELD_TYPE", "C", 10, 0}  }, "TOPCONN")
  
  DBUseArea(.F., 'TOPCONN', cT1, (cT1), .F., .T.)
 
  DBCreateIndex("T1INDEX1", "FIELD_NAME", {|| FIELD_NAME })
  DBCreateIndex("T1INDEX2", "FIELD_TYPE+FIELD_NAME" , {|| FIELD_TYPE+FIELD_NAME })
  
  DBSetIndex("T1INDEX1")
  DBSetIndex("T1INDEX2")
  
  conout(OrdKey("T1INDEX1")) // retorna FIELD_NAME no console
  conout(OrdKey(2)) // retorna FIELD_TYPE+FIELD_NAME no console
  
  DBCloseArea()
  
  TCUnlink()
RETURN

Veja também

  • Sem rótulos