LocalDBGetInstances 関数

指定したバージョンのすべての SQL Server Express LocalDB インスタンスを返します。

ヘッダー ファイル: sqlncli.h

構文

#define MAX_LOCALDB_INSTANCE_NAME_LENGTH 128
typedef WCHAR TLocalDBInstanceName[MAX_LOCALDB_INSTANCE_NAME_LENGTH + 1];
typedef TLocalDBInstanceName* PTLocalDBInstanceName;

HRESULT LocalDBGetInstances(
           PTLocalDBInstanceName pInstanceNames,
           LPDWORD lpdwNumberOfInstances
);

パラメーター

• pInstanceNames
  [出力] この関数が返す場合、ユーザーのワークステーション上の名前付きおよび既定の LocalDB インスタンスの両方の名前を格納します。

• lpdwNumberOfInstances
  [入出力] 入力側で pInstanceNames バッファーにあるインスタンス名のスロットの数を格納します。 出力側では、ユーザーのワークステーション上で見つかった LocalDB インスタンスの数を格納します。

戻り値

• S_OK
  関数が正常に実行されました。

• LOCALDB_ERROR_NOT_INSTALLED
  SQL Server Express LocalDB は、コンピューターにインストールされていません。

• LOCALDB_ERROR_INVALID_PARAMETER
  指定した 1 つまたは複数の入力パラメーターが無効です。

• LOCALDB_ERROR_INSUFFICIENT_BUFFER
  入力バッファーが短かすぎますが、切り捨ては要求されませんでした。

• LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG
  インスタンスを格納するパスの長さが MAX_PATH を超過しています。

• LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY
  インスタンス レジストリにアクセスできません。

• LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT
  インスタンス構成が破損しています。

• LOCALDB_ERROR_INTERNAL_ERROR
  予期しないエラーが発生しました。 詳細をイベント ログで確認してください。

説明

LocalDB API を使用するコード例については、「SQL Server Express LocalDB リファレンス」を参照してください。

関連項目

概念

SQL Server Express LocalDB ヘッダーとバージョン情報