OrdBagName

Retorna uma string com o alias da Ordem de Índice pesquisada.

Sintaxe

OrdBagName( < xExp > )

Parâmetros

Retorno

Observações

• A função OrdBagName recebe apenas um parâmetro, que pode ser do tipo Caractere ou Numérico.
  Caso seja informado um parâmetro de tipo diferente, a seguinte mensagem de erro será exibida: "OrdBagName - First parameter must be numeric or character".
• Caso o alias ou a ordem de índice pesquisado não exista, o retorno da função será uma string vazia ("").
• Caso a função OrdBagName seja executada sem uma área ativa, a seguinte mensagem de erro será exibida: Work area not in use
• Quando o parâmetro repassado a função for do tipo numérico, para a RDD "TOPCONN", seu retorno será uma string com caracteres minúsculos.
• Quando o parâmetro repassado a função for do tipo caractere, para a RDD "TOPCONN", seu retorno será uma string com caracteres maiúsculos.

Exemplos

O exemplo abaixo utiliza a RDD "TOPCONN", mas a função pode ser utilizada com qualquer uma das RDDs válidas.

user function test()
  local cT1 := "T1"
  
  TCLink()
  if TCCanOpen(cT1)
    TCDelFile(cT1)
  endif
  
  DBCreate(cT1,  {{"T1_COD" , "C",  2, 0}, ;
                  {"T1_NAME", "C", 10, 0}}, "TOPCONN")
                  
  DBUseArea(.T., "TOPCONN", cT1, (cT1), .F., .F.)
    
  DBCreateIndex("T1INDEX1", "T1_COD"         , {|| T1_COD         })
  DBCreateIndex("T1INDEX2", "T1_COD+T1_NAME" , {|| T1_COD+T1_NAME })
  (cT1)->( DBClearIndex() ) //Força o fechamento dos indices abertos

  DBSetIndex("T1INDEX1") //acrescenta a ordem de indice para a área aberta
  DBSetIndex("T1INDEX2") //acrescenta a ordem de indice para a área aberta
  
  msgInfo("Alias da ordem de índice pesquisada: " + upper( OrdBagName(2) ))
     
  DBCloseArea()
  TCUnLink()

return

Veja também

• DBCreateIndex
• DBSetIndex