Compartilhar via


LocalDBStartInstance function

Applies to:SQL Server

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

Header file:msoledbsql.h

Syntax

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

Arguments

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.

lpcchSqlConnection

[Input/Output] On input contains the size of the wszSqlConnection buffer in characters, including any trailing nulls. 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.

Returns

S_OK: a função foi bem-sucedida.

Error Description
LOCALDB_ERROR_NOT_INSTALLED O SQL Server Express LocalDB 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 The specified buffer wszSqlConnection is too small.
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 ser armazenada é maior que MAX_PATH.
LOCALDB_ERROR_CANNOT_GET_USER_PROFILE_FOLDER Uma pasta de perfil de usuário não pode ser recuperada.
LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_FOLDER Uma pasta de instância não pode ser acessada.
LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY Não é possível acessar um registro de instância.
LOCALDB_ERROR_CANNOT_MODIFY_INSTANCE_REGISTRY Um registro de instância não pode ser modificado.
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.

Details

Both the connection buffer argument (wszSqlConnection) and the connection buffer size argument (lpcchSqlConnection) are optional. A tabela a seguir mostra opções para o uso desses argumentos e seus resultados.

Buffer Buffer size Rationale Action
NULL NULL 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).
NULL Present 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.
Present NULL Não permitido; entrada incorreta. O resultado retornado é LOCALDB_ERROR_INVALID_PARAMETER.
Present Present O usuário deseja iniciar a instância e precisa do nome do pipe para se conectar a ela depois que ela for iniciada. 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 um exemplo de código que usa a API localdb, consulte a referência do SQL Server Express LocalDB.