指定した SQL Server Express LocalDB インスタンスを開始します。
ヘッダー ファイル: sqlncli.h
構文
HRESULT LocalDBStartInstance(
PCWSTR pInstanceName,
DWORD dwFlags,
LPWSTR wszSqlConnection,
LPDWORD lpcchSqlConnection
);
パラメーター
pInstanceName
[入力]開始する LocalDB インスタンスの名前。
dwFlags
[入力]将来の使用のために予約されています。 現在は 0 に設定する必要があります。
wszSqlConnection
[出力]LocalDB インスタンスへの接続文字列を格納するバッファー。
lpcchSqlConnection
[入力/出力]入力時には、末尾の null を含む wszSqlConnection バッファーのサイズが文字で格納されます。 出力時に、指定されたバッファー サイズが小さすぎる場合は、末尾の null を含め、必要なバッファー サイズが文字で格納されます。
返品ポリシー
S_OK
関数は成功しました。
LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB がコンピューターにインストールされていません。
LOCALDB_ERROR_INVALID_PARAMETER
1 つ以上の指定された入力パラメーターが無効です。
LOCALDB_ERROR_INVALID_INSTANCE_NAME
指定されたインスタンス名が無効です。
LOCALDB_ERROR_UNKNOWN_INSTANCE
インスタンスが存在しません。
LOCALDB_ERROR_INSUFFICIENT_BUFFER
指定されたバッファー wszSqlConnection が小さすぎます。
LOCALDB_ERROR_WAIT_TIMEOUT
同期ロックの取得中にタイムアウトが発生しました。
LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG
インスタンスを格納する必要があるパスは、MAX_PATHよりも長くなります。
LOCALDB_ERROR_CANNOT_GET_USER_PROFILE_FOLDER
ユーザー プロファイル フォルダーを取得できません。
LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_FOLDER
インスタンス フォルダーにアクセスできません。
LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY
インスタンス レジストリにアクセスできません。
LOCALDB_ERROR_CANNOT_MODIFY_INSTANCE_REGISTRY
インスタンス レジストリは変更できません。
LOCALDB_ERROR_CANNOT_CREATE_SQL_PROCESS
SQL Server のプロセスを作成できません。
LOCALDB_ERROR_SQL_SERVER_STARTUP_FAILED
SQL Server プロセスが開始されましたが、SQL Server の起動に失敗しました。
LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT
インスタンス構成が破損しています。
LOCALDB_ERROR_AUTO_INSTANCE_CREATE_FAILED
自動インスタンスを作成できません。 エラーの詳細については、Windows アプリケーション のイベント ログを参照してください。
LOCALDB_ERROR_INTERNAL_ERROR
予期しないエラーが発生しました。 詳細については、イベント ログを参照してください。
詳細
接続バッファー引数 (wszSqlConnection) と接続バッファー サイズ引数 (lpcchSqlConnection) はどちらも省略可能です。 次の表に、これらの引数とその結果を使用するためのオプションを示します。
| バッファ | バッファー サイズ | 理由 | アクション |
|---|---|---|---|
| ヌル | ヌル | ユーザーはインスタンスを開始する必要があり、パイプ名は必要ありません。 | インスタンスを開始します (パイプの戻り値がなく、必要なバッファー サイズの戻り値もありません)。 |
| ヌル | プレゼント | ユーザーが出力バッファー サイズを要求します。 (次の呼び出しでは、ユーザーは実際の開始を要求する可能性があります)。 | 必要なバッファー サイズを返します (開始およびパイプの戻り値なし)。 結果はS_OK。 |
| プレゼント | ヌル | 禁じられた;入力が正しくありません。 | 返される結果はLOCALDB_ERROR_INVALID_PARAMETER。 |
| プレゼント | プレゼント | ユーザーはインスタンスを起動する必要があり、起動後にパイプ名を接続する必要があります。 | バッファー サイズを確認し、インスタンスを開始し、バッファー内のパイプ名を返します。 バッファー サイズ引数は、終端の null を含まない 、"server=" 文字列の長さを返します。 |
LocalDB API を使用するコード サンプルについては、「 SQL Server Express LocalDB リファレンス」を参照してください。