TCConfig

Permite alterar e consultar definições e configurações diversas do DBAccess em tempo de execução.

Sintaxe

TCConfig( < cParms > )

Parâmetros

Retorno

Observações

• O parâmetro cParms é uma string que identifica a ação ou configuração a ser consultada, ou alterada. Para obter a lista de configurações possíveis – separadas por ";" – chame a função com o parâmetro 'ALL_CONFIG_OPTIONS'. Caso seja informada uma configuração desconhecida, a função retorna uma string em branco.
• ALL_CONFIG_OPTIONS : Lista todas as configurações disponíveis.
• SETUSEROWSTAMP=ON|OFF : Permite ligar ou desligar a criação da coluna interna S_T_A_M_P_ para novas tabelas. Pode retornar "OK" em caso de sucesso, "NOT_SUPPORTED" caso o Banco de Dados não tenha suporte para a coluna S_T_A_M_P_, ou "INVALID_OPTION" caso seja informado um parâmetro diferente de "ON" ou "OFF".
• GETUSEROWSTAMP : Consulta se a criação da coluna S_T_A_M_P_ para novas tabelas está habilitada, retorna "ON" ou "OFF".
• SETAUTOSTAMP=ON|OFF : Permite habilitar a criação automática da coluna S_T_A_M_P_ na abertura da tabela. Pode retornar "OK" em caso de sucesso, "NOT_SUPPORTED" caso o Banco de Dados não tenha suporte para a coluna S_T_A_M_P_, ou "INVALID_OPTION" caso seja informado um parâmetro diferente de "ON" ou "OFF".
• GETAUTOSTAMP : Consulta se a criação automática da coluna S_T_A_M_P_ na abertura da tabela está habilitada, retorna "ON" ou "OFF".
• SETMEMOINQUERY=ON|OFF : Define para a conexão atual se o retorno de campos MEMO em Query está habilitado para Queries executadas através do AdvPL usando a função TCGenQry(). Retorna "OK" em caso de sucesso, ou "INVALID_OPTION" caso seja informado um parâmetro diferente de "ON" ou "OFF".
• GETMEMOINQUERY : Consulta se o retorno de campos MEMO em Query está habilitado no momento para a conexão atual, retorna "ON" ou "OFF".

As opções abaixo estarão disponíveis a partir do DBAccess Build 20200606:

• SETUSEROWINSDT=ON|OFF : Permite ligar ou desligar a criação da coluna interna I_N_S_D_T_ para novas tabelas. Pode retornar "OK" em caso de sucesso, "NOT_SUPPORTED" caso o Banco de Dados não tenha suporte para a coluna I_N_S_D_T_, ou "INVALID_OPTION" caso seja informado um parâmetro diferente de "ON" ou "OFF".
• GETUSEROWINSDT : Consulta se a criação da coluna I_N_S_D_T_ para novas tabelas está habilitada, retorna "ON" ou "OFF".
• SETAUTOINSDT=ON|OFF : Permite habilitar a criação automática da coluna I_N_S_D_T_ na abertura da tabela. Pode retornar "OK" em caso de sucesso, "NOT_SUPPORTED" caso o Banco de Dados não tenha suporte para a coluna I_N_S_D_T_, ou "INVALID_OPTION" caso seja informado um parâmetro diferente de "ON" ou "OFF".
• GETAUTOINSDT : Consulta se a criação automática da coluna I_N_S_D_T_ na abertura da tabela está habilitada, retorna "ON" ou "OFF".

As opções abaixo estarão disponíveis a partir do DBAccess Build 20200713:

As opções abaixo estarão disponíveis a partir do DBAccess Build 20210202:

• TCSOFTREFRESH=ON|OFF : Permite habilitar uma mudança de comportamento na função TCRefresh(), chamado de "Soft Refresh", para que ela não refaça o cache da definição de campos e índices da tabela, mas apenas atualize o registro de último registro inserido no banco de dados.
• GETTCSOFTREFRESH : Consulta se o comportamento de "Soft Refresh" está habilitada, retorna "ON" ou "OFF".

As opções abaixo estarão disponíveis a partir do DBAccess Build 20210911:

• GETAUTORECNO : consulta se o comportamento de "AUTORECNO" está habilitada, retorna "ON" ou "OFF".
• SETAUTORECNO=ON|OFF : permite habilitar o auto RECNO, que faz com que o banco trate o incremento do campo RECNO, retirando esse controle do DBAccess.

As opções abaixo estarão disponíveis a partir da versão do DBAccess 24.1.0.0:

• SETVIEWENABLED=ON|OFF : Habilita a consulta ao catalogo do banco de dados para procurar por views.
• GETVIEWENABLED : Retorna se a opção VIEWENABLED está habilitada.

Exemplos

// No exemplo abaixo listamos em um array todas as configurações disponíveis
user function teste()
  Local nI, cConfig, aConfig
  
  TCLink()
  
  cConfig := TCConfig( 'ALL_CONFIG_OPTIONS' )
  
  aConfig := StrTokArr( cConfig, ';' )
  For nI := 1 to len( aConfigs )
    conout( aConfigs[nI] )
  Next
  
  TCUnlink()
return

Veja também

• Implementação - Campo de controle adicional no DBAccess - S_T_A_M_P_
• Implementação - Campo de controle adicional no DBAccess - I_N_S_D_T_