Função JetSetSessionParameter

Aplica-se a: Windows | Windows Server

A função JetSetSessionParameter configura o mecanismo de banco de dados.

JET_ERR JET_API JetSetSessionParameter (
  __in_opt      JET_SESID sesid,
  __in          unsigned long sesparamid,
  __in_read_bytes_opt_(cbParam)  void* pvParam,
  __in          unsigned long cbParam
);

Parâmetros

sesid

Especifica a sessão a ser usada para essa chamada.

Quando especificada, a instância especificada é ignorada e a instância associada à sessão será usada.

sesparamid

A ID do parâmetro de sessão a ser definido.

pvParam

Os dados a serem definidos neste parâmetro de sessão.

cbParam

O tamanho dos dados fornecidos.

Valor retornado

Essa função retorna o tipo de dados JET_ERR com um dos códigos de retorno listados na tabela a seguir. Para obter mais informações sobre os possíveis erros do ESE (Mecanismo de Armazenamento Extensível), consulte Erros extensíveis do mecanismo de armazenamento e parâmetros de tratamento de erros.

Código de retorno	Descrição
JET_errSuccess	A operação foi concluída com sucesso.
JET_errAlreadyInitialized	A instância foi inicializada usando uma chamada para a função JetInit e essa operação não pode ser executada como resultado. Isso pode acontecer quando é feita uma tentativa de configurar um parâmetro do sistema depois que uma alteração no valor do parâmetro não pode mais afetar o estado do mecanismo de banco de dados.
JET_errClientRequestToStopJetService	Não é possível concluir a operação porque todas as atividades na instância associada à sessão cessaram como resultado de uma chamada para a função JetStopService .
JET_errIndexTuplesInvalidLimits	Os parâmetros de índice de tupla especificados eram ilegais. Esse erro é retornado somente quando o parâmetro JET_paramIndexTuplesLengthMin, JET_paramIndexTuplesLengthMax ou JET_paramIndexTuplesToIndexMax é definido como um valor inválido. Para obter informações sobre esses parâmetros, consulte Parâmetros de índice.
JET_errInitInProgress	Não é possível concluir a operação porque a instância associada à sessão está sendo inicializada.
JET_errInstanceUnavailable	Não é possível concluir a operação porque a instância associada à sessão encontrou um erro fatal que exige que o acesso a todos os dados seja revogado para proteger a integridade desses dados.
JET_errInvalidParameter	Um dos parâmetros fornecidos continha um valor inesperado ou continha um valor que não fazia sentido quando combinado com o valor de outro parâmetro. Isso pode acontecer quando ocorre o seguinte: A ID do parâmetro do sistema especificada é inválida ou sem suporte. Foi feita uma tentativa de definir um parâmetro de sistema com valor de cadeia de caracteres com uma cadeia de caracteres cujo comprimento estava fora do intervalo legal para o parâmetro . Foi feita uma tentativa de definir um parâmetro de sistema com valor de cadeia de caracteres com um caminho de arquivo em que o comprimento de sua representação de caminho absoluto estava fora do intervalo legal para esse parâmetro. Foi feita uma tentativa de definir um parâmetro de sistema com valor inteiro com um inteiro que estava fora do intervalo legal para o parâmetro . Foi feita uma tentativa de definir JET_paramUnicodeIndexDefault com um ponteiro de JET_UNICODEINDEX nulo, um LCID inválido ou um conjunto sem suporte de sinalizadores LCMapString . O parâmetro do sistema especificado não pode ser definido porque é somente leitura. Foi feita uma tentativa de definir um parâmetro do sistema depois que a função JetInit foi chamada, o mecanismo de banco de dados está no modo de instância única e uma sessão não foi especificada. O parâmetro do sistema especificado é apenas global e foi feita uma tentativa de definir um valor específico da instância para esse parâmetro do sistema. O parâmetro do sistema especificado é somente por instância e foi feita uma tentativa de definir o valor global para esse parâmetro do sistema.
JET_errInvalidPath	O caminho do sistema de arquivos especificado era inválido. Esse erro pode ser retornado por JetSetSessionParameter somente ao definir parâmetros do sistema que representam caminhos do sistema de arquivos. Por exemplo, o parâmetro JET_paramSystemPath pode retornar esse erro. Para obter informações sobre esse parâmetro, consulte Parâmetros de log de transações.
JET_errNotInitialized	Não é possível concluir a operação porque a instância associada à sessão ainda não foi inicializada.
JET_errRestoreInProgress	Não é possível concluir a operação porque uma operação de restauração está em andamento na instância associada à sessão.
JET_errTermInProgress	Não é possível concluir a operação porque a instância associada à sessão está sendo desligada.
JET_errInvalidSesid	O identificador de sessão é inválido ou refere-se a uma sessão fechada. Esse erro não é retornado em todas as circunstâncias. Os identificadores são validados apenas com base no melhor esforço.
JET_errInvalidInstance	O identificador de instância é inválido ou refere-se a uma instância que foi desligada. Esse erro não é retornado em todas as circunstâncias. Os identificadores são validados apenas com base no melhor esforço.

Em caso de êxito, o parâmetro do sistema será definido como o valor fornecido.

Em caso de falha, o valor do parâmetro do sistema permanecerá inalterado.

Requisitos

Requisito	Valor
Cliente	Requer Windows 8.
Servidor	Requer Windows Server 2012.
Cabeçalho	Declarado em Esent.h.
Biblioteca	Use ESENT.lib.
DLL	Requer ESENT.dll.

Confira também

JET_API_PTR
JET_ERR
JET_INSTANCE
JET_SESID
JetCreateInstance
JetGetSystemParameter
JetInit
Parâmetros do sistema