Função JetSetColumnDefaultValue

Artigo
06/13/2023

Aplica-se a: Windows | Windows Server

Função JetSetColumnDefaultValue

A função JetSetColumnDefaultValue pode ser usada para alterar o valor padrão de uma coluna existente.

    JET_ERR JET_API JetSetColumnDefaultValue(
      __in          JET_SESID sesid,
      __in          JET_DBID dbid,
      __in          JET_PCSTR szTableName,
      __in          JET_PCSTR szColumnName,
      __in          const void* pvData,
      __in          const unsigned long cbData,
      __in          const JET_GRBIT grbit
    );

Parâmetros

sesid

A sessão a ser usada para essa chamada.

dbid

O banco de dados a ser usado para essa chamada.

szTableName

O nome da tabela que contém a coluna que será afetada.

szColumnName

O nome da coluna cujo valor padrão será alterado.

pvData

O buffer de entrada que contém o novo valor padrão.

cbData

O tamanho do buffer de entrada que contém o novo valor padrão.

grbit

Reservado para uso futuro.

Valor Retornado

Essa função retorna o tipo de dados JET_ERR com um dos seguintes códigos de retorno. Para obter mais informações sobre os possíveis erros do ESE, 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_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 JetStopService.
JET_errColumnIllegalNull	O mesmo que JET_errNullInvalid.
JET_errColumnInUse	Esta coluna especificada está atualmente em uso por um índice. JetSetColumnDefaultValue não pode alterar o valor padrão de uma coluna referenciada na definição de um índice. Isso ocorre porque isso pode alterar o conteúdo do índice.
JET_errColumnNotFound	Esta coluna especificada não existe para esta tabela.
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. Esse erro só será retornado pelo Windows XP e versões posteriores.
JET_errInvalidDatabaseId	A ID do banco de dados especificada era inválida.
JET_errInvalidName	Um dos nomes de objeto especificados era inválido. Todos os nomes de objeto devem estar em conformidade com o mesmo conjunto de regras. Essas regras são as seguintes: Os nomes de objeto devem ser compostos por caracteres ASCII. Os nomes de objeto devem ter pelo menos um caractere de comprimento. Os nomes de objetos não podem exceder JET_cbNameMost (64) caracteres de comprimento. Os nomes de objetos podem não começar com um espaço. Os nomes de objeto podem não conter caracteres de controle ASCII (0x00 por meio de 0x1F). Os nomes de objeto podem não conter um ponto de exclamação (!), ponto (.), um caractere de colchete esquerdo ([) ou colchete direito (]). Depois de validado, somente a parte da cadeia de caracteres até o primeiro espaço (se houver) será usada para o nome do objeto. Isso significa que os nomes de objeto também podem não conter um espaço.
JET_errNotInitialized	Não é possível concluir a operação porque a instância associada à sessão ainda não foi inicializada.
JET_errNullInvalid	A coluna não pôde ser definida como NULL. Isso acontece para JetSetColumnDefaultValue quando: cbData é zero. pvData é NULL. Portanto, não é possível definir o valor padrão de uma coluna (back) como NULL ou como um valor de comprimento zero.
JET_errObjectNotFound	Esta tabela especificada não existe para esse banco de dados.
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_errSessionSharingViolation	A mesma sessão não pode ser usada para mais de um thread ao mesmo tempo. Esse erro só será retornado pelo Windows XP e versões posteriores.
JET_errTableInUse	Esta tabela especificada está em uso por outra sessão. JetSetColumnDefaultValue requer acesso exclusivo a uma tabela para alterar o valor padrão da coluna para versões anteriores ao Windows Server 2003.
JET_errTermInProgress	Não é possível concluir a operação porque a instância associada à sessão está sendo desligada.
JET_errTransReadOnly	É inválido tentar uma atualização quando dentro do escopo de uma transação somente leitura. Uma transação somente leitura é uma transação que foi iniciada usando uma chamada para JetBeginTransaction2 com JET_bitTransactionReadOnly. Esse erro só será retornado pelo Windows XP e versões posteriores.
JET_errWriteConflict	Outra sessão bloqueou anteriormente o registro para atualização. A atualização tentada por esta sessão falhará.

Em caso de êxito, o valor padrão da coluna especificada na tabela especificada no banco de dados fornecido é alterado permanentemente para o novo valor padrão.

Em caso de falha, nenhuma alteração no estado do banco de dados ocorrerá.

Comentários

Não é possível alterar o valor padrão de uma coluna em uma tabela de modelo.

O mecanismo de banco de dados truncará silenciosamente o valor padrão de uma coluna para 255 bytes para texto longo e colunas binárias longas.

Requisitos

Requisito	Valor
Cliente	Requer Windows Vista, Windows XP ou Windows 2000 Professional.
Servidor	Requer o Windows Server 2008, o Windows Server 2003 ou o Windows 2000 Server.
Cabeçalho	Declarado em Esent.h.
Biblioteca	Use ESENT.lib.
DLL	Requer ESENT.dll.
Unicode	Implementado como JetSetColumnDefaultValueW (Unicode) e JetSetColumnDefaultValueA (ANSI).

Consulte Também

JET_DBID
JET_ERR
JET_GRBIT
JET_SESID
JetBeginTransaction2
JetStopService

Compartilhar via

Função JetSetColumnDefaultValue