指定した SQL Server Express LocalDB バージョンの情報 (存在するかどうか、完全な LocalDB バージョン番号 (ビルド番号やリリース番号を含む) など) を返します。
この情報は、LocalDBVersionInfo という名前の struct の形式で返されます。 LocalDBVersionInfo には次の定義があります。
typedef struct _LocalDBVersionInfo
{
// Contains the size of the LocalDBVersionInfo struct
DWORD cbLocalDBVersionInfoSize;
// Holds the version name
TLocalDBVersionwszVersion;
// TRUE if the instance files exist on disk, FALSE otherwise
BOOL bExists;
// Holds the LocalDB version for the instance in the format: major.minor.build.revision
DWORD dwMajor;
DWORD dwMinor;
DWORD dwBuild;
DWORD dwRevision;
} LocalDBVersionInfo;
ヘッダー ファイル: sqlncli.h
構文
HRESULT LocalDBGetVersionInfo(
PCWSTR wszVersionName, PLocalDBVersionInfo pVersionInfo, DWORD dwVersionInfoSize);
パラメーター
wszVersionName
[入力]LocalDB のバージョン名。
pVersionInfo
[出力]LocalDB バージョンに関する情報を格納するバッファー。
dwVersionInfoSize
[入力] VersionInfo バッファーのサイズを保持します。
返品ポリシー
S_OK
関数は成功しました。
LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB がコンピューターにインストールされていません。
LOCALDB_ERROR_INVALID_PARAMETER
1 つ以上の指定された入力パラメーターが無効です。
LOCALDB_ERROR_UNKNOWN_VERSION
指定された LocalDB バージョンが存在しません。
LOCALDB_ERROR_INTERNAL_ERROR
予期しないエラーが発生しました。 詳細については、イベント ログを参照してください。
詳細
struct サイズ引数 (lpVersionInfoSize) の導入の背後にある根拠は、API が異なるバージョンの LocalDBVersionInfostruct を返し、実質的に前方互換性と下位互換性を有効にできるようにすることです。
struct size 引数 (lpVersionInfoSize) が LocalDBVersionInfostruct の既知のバージョンのサイズと一致する場合は、そのバージョンのstructが返されます。 それ以外の場合は、LOCALDB_ERROR_INVALID_PARAMETERが返されます。
LocalDBGetVersionInfo API の一般的な使用例は次のようになります。
LocalDBVersionInfo vi;
LocalDBVersionInfo(L"11.0", &vi, sizeof(LocalDBVersionInfo));
注釈
LocalDB API を使用するコード サンプルについては、「 SQL Server Express LocalDB リファレンス」を参照してください。