Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Correção da documentação para alinhar com o comportamento da função e melhoria no exemplo AdvPL

...

Portuguese

Pagetitle
DBOrderInfo
DBOrderInfo

Função: DBOrderInfo

Obtêm informações sobre determinada ordem de índice.

DBOrderInfo ( < nInfoTipo> nTipoInfo> ) --> xInfo

 

NomeTipoDescriçãoObrigatórioReferência
nInfoTiponTipoInfoNuméricoIndica o nome do arquivo de índice. Para mais informações, consulte a área Observações.X 

 

xInfo
    (qualquer)
  • Retorna a informação da ordem requisitada pelo usuário (tipo numérico, se for número de ordens no índice, tipo caracter, se for nome do arquivo de índice. Caso não exista a ordem corrente ou a posição da ordem é inválida, o retorno será nulo ("").
  • A especificação da ordem pode ser realizada através de seu nome ou sua posição na lista de ordens. Mas, se a ordem não for especificada, as informações serão obtidas da ordem corrente.
  • O tipo de informação, do parâmetro <nInfoTipo>, é escolhido de acordo com as seguintes constantes:<nTipoInfo>, pode ser:

 

Valor
Constante
Descrição
DBOI_BagName 

7

Indica o nome do arquivo de índice ao qual a ordem pertence. Tipo: Caracter. 

DBOI_FullPath 

20

Indica o nome do arquivo de índice (com seu diretório) ao qual a ordem pertence. Tipo: Caracter. 

DBOI_OrderCount 

9

Indica o número de ordens

existentes no arquivo de índice especificado.

de índices abertas para o arquivo atual. Tipo: Numérico

 

 

// Este exemplo, apresenta como utilizar a função DBOrderInfo() para obter informações
// sobre o nome do arquivo de índice da ordem corrente.DBOrderInfo(DBOI_BAGNAME
ChkFile("SA1")
DbSetOrder(1)
MsgStop(DBOrderInfo(7)) // Retorna: IndDBOrderInfo(DBOI_FULLPATH"SA10101"
MsgStop(DBOrderInfo(20)) // Retorna: C:\APX\Teste\Ind.cdx"SA10101"
 
Advanced Protheus 6.09 , Advanced Protheus 7.10 , Microsiga Protheus 8.11 , Protheus 10 , TOTVS Application Server 10 , ByYou Application Server Protheus 11, Protheus 12