Поделиться через

LocalDBGetInstanceInfo function

Applies to:SQL Server

Возвращает сведения для указанного экземпляра SQL Server Express LocalDB, например, существует ли она, используется версия LocalDB, работает ли она, и т. д.

Сведения возвращаются в именованном LocalDBInstanceInfoобъектеstruct, который имеет следующее определение.

typedef struct _LocalDBInstanceInfo
{
      // Contains the size of the LocalDBInstanceInfo struct
      DWORD  cbLocalDBInstanceInfoSize;

      // Holds the instance name
      TLocalDBInstanceNamewszInstanceName;

      // TRUE if the instance files exist on disk, FALSE otherwise
      BOOL   bExists;

      // TRUE if the instance configuration registry is corrupted, FALSE otherwise
      BOOLbConfigurationCorrupted;

      // TRUE if the instance is running at the moment, FALSE otherwise
      BOOL   bIsRunning;

      // Holds the LocalDB version for the instance in the format: major.minor.build.revision
      DWORD  dwMajor;
      DWORD  dwMinor;
      DWORD  dwBuild;
      DWORD  dwRevision;

      // Holds the date and time when the instance was started for the last time
      FILETIME ftLastStartUTC;

      // Holds the name of the TDS named pipe to connect to the instance
      WCHARwszConnection;

      // TRUE if the instance is shared, FALSE otherwise
      BOOLbIsShared;

      // Holds the shared name for the instance (if the instance is shared)
      TLocalDBInstanceNamewszSharedInstanceName;

      // Holds the SID of the instance owner (if the instance is shared)
      WCHARwszOwnerSID;

      // TRUE if the instance is Automatic, FALSE otherwise
      BOOLbIsAutomatic;
} LocalDBInstanceInfo;

Header file:msoledbsql.h

Syntax

HRESULT LocalDBGetInstanceInfo(
           PCWSTR wszInstanceName ,
           PLocalDBInstanceInfo pInstanceInfo ,
           DWORD dwInstanceInfoSize
);

Arguments

wszInstanceName

[Вход] Имя экземпляра.

pInstanceInfo

[Выход] Буфер для сохранения сведений об экземпляре LocalDB.

dwInstanceInfoSize

[Input] Holds the size of the InstanceInfo buffer.

Returns

S_OK: функция завершилась успешно.

Error Description
LOCALDB_ERROR_NOT_INSTALLED SQL Server Express LocalDB не установлен на компьютере.
LOCALDB_ERROR_INVALID_PARAMETER Один или несколько указанных входных параметров недопустимы.
LOCALDB_ERROR_INVALID_INSTANCE_NAME Указанное имя экземпляра недопустимо.
LOCALDB_ERROR_UNKNOWN_INSTANCE Экземпляр не существует.
LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG Путь, в котором должен храниться экземпляр, превышает длину MAX_PATH.
LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_FOLDER Доступ к папке экземпляра невозможно.
LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY Доступ к реестру экземпляров невозможно.
LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT Конфигурация экземпляра повреждена.
LOCALDB_ERROR_INTERNAL_ERROR Произошла непредвиденная ошибка. Подробные сведения см. в журнале событий.

Details

The rationale behind the introduction of the struct size argument (lpInstanceInfoSize) is to enable the API to return different versions of the LocalDBInstanceInfostruct, effectively enabling forward and backward compatibility.

If the struct size argument (lpInstanceInfoSize) matches the size of a known version of the LocalDBInstanceInfostruct, that version of the struct is returned. В противном случае возвращается LOCALDB_ERROR_INVALID_PARAMETER.

Типичный LocalDBGetInstanceInfo пример использования API выглядит следующим образом:

LocalDBInstanceInfo ii;
LocalDBInstanceInfo(L"Test", &ii, sizeof(LocalDBInstanceInfo));

Пример кода, использующий API LocalDB, см. в справочнике по SQL Server Express LocalDB.

Related content

  • Last updated on