Função LocalDBStartInstance

Artigo
07/04/2024

Aplica-se: SQL Server

Inicia a instância especificada de LocalDB do SQL Server Express.

Arquivo de cabeçalho: msoledbsql.h

Sintaxe

HRESULT LocalDBStartInstance(  
           PCWSTR pInstanceName,  
           DWORD dwFlags,   
           LPWSTR wszSqlConnection,   
           LPDWORD lpcchSqlConnection   
);

Parâmetros

pInstanceName
[Entrada] O nome da instância de LocalDB a ser iniciada.

dwFlags
[Entrada] Reservado para uso futuro. Atualmente deve ser definido como 0.

wszSqlConnection
[Saída] O buffer para armazenar a cadeia de conexão na instância de LocalDB.

lpcchConexão Sql
[Saída/entrada] On input contém o tamanho do buffer wszSqlConnection em caracteres, incluindo qualquer caractere nulo à esquerda. Na saída, se o tamanho de buffer especificado for muito pequeno, conterá o tamanho de buffer necessário em caracteres, incluindo quaisquer caracteres nulos à esquerda.

Devoluções

S_OK
A função foi bem-sucedida.

LOCALDB_ERROR_NOT_INSTALLED
O LocalDB do SQL Server Express não está instalado no computador.

LOCALDB_ERROR_INVALID_PARAMETER
Um ou mais parâmetros de entrada especificados são inválidos.

LOCALDB_ERROR_INVALID_INSTANCE_NAME
O nome de instância especificado é inválido.

LOCALDB_ERROR_UNKNOWN_INSTANCE
A instância não existe.

LOCALDB_ERROR_INSUFFICIENT_BUFFER
O buffer wszSqlConnection especificado é muito pequeno.

LOCALDB_ERROR_WAIT_TIMEOUT
Tempo limite esgotado durante tentativa de obtenção de bloqueios de sincronização.

LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG
O caminho em que a instância deve estar armazenada não é maior que MAX_PATH.

LOCALDB_ERROR_CANNOT_GET_USER_PROFILE_FOLDER
Não é possível recuperar uma pasta de perfil de usuário.

LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_FOLDER
Não é possível acessar uma pasta de instância.

LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY
Não é possível acessar um registro de instância.

LOCALDB_ERROR_CANNOT_MODIFY_INSTANCE_REGISTRY
Não é possível modificar um registro de instância.

LOCALDB_ERROR_CANNOT_CREATE_SQL_PROCESS
Não é possível criar um processo para o SQL Server.

LOCALDB_ERROR_SQL_SERVER_STARTUP_FAILED
Um processo do SQL Server foi iniciado, mas houve falha na inicialização do SQL Server.

LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT
Uma configuração de instância foi corrompida.

LOCALDB_ERROR_AUTO_INSTANCE_CREATE_FAILED
Não é possível criar uma instância automática. Consulte o log de eventos de Aplicativo do Windows para obter detalhes sobre o erro.

LOCALDB_ERROR_INTERNAL_ERROR
Erro inesperado. Consulte o log de eventos para obter detalhes.

Detalhes

O argumento do buffer de conexão (wszSqlConnection) e o argumento do tamanho do buffer de conexão (lpcchSqlConnection) são opcionais. A tabela a seguir mostra opções para o uso desses argumentos e seus resultados.

Buffer	Tamanho do buffer	Fundamento	Ação
NULO	NULO	O usuário deseja iniciar a instância e não precisa de um nome de pipe.	Inicia uma instância (sem retorno de pipe e sem retorno do tamanho de buffer necessário).
NULO	Presente	O usuário solicita o tamanho do buffer de saída. (Na próxima chamada, o usuário provavelmente solicitará uma inicialização real.)	Retorna um tamanho de buffer necessário (sem inicialização e sem retorno de pipe). O resultado é S_OK.
Presente	NULO	Não permitido; entrada incorreta.	O resultado retornado é LOCALDB_ERROR_INVALID_PARAMETER.
Presente	Presente	O usuário deseja iniciar a instância e precisa do nome do pipe para se conectar a ela após a inicialização.	Verifica o tamanho do buffer, inicia a instância e retorna o nome do pipe no buffer. O argumento de tamanho do buffer retorna o comprimento da string "server=", sem incluir nulos de terminação.

Para obter uma amostra do código que usa a API LocalDB, consulte SQL Server Express LocalDB Reference.

Confira também

Cabeçalho e informações de versão de LocalDB do SQL Server Express

Partilhar via