Функция LocalDBGetInstanceInfo

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

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

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;  
  

Файл заголовка: sqlncli.h

Синтаксис

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

Параметры

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

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

dwInstanceInfoSize
[Входные данные] Содержит размер буфера InstanceInfo .

Возвраты

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

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
Произошла непредвиденная ошибка. Дополнительные сведения см. в журнале событий.

Сведения

Обоснование внедрения аргумента struct размера (lpInstanceInfoSize) заключается в том, чтобы API возвращал различные версии структуры LocalDBInstanceInfoinfo, эффективно обеспечивая обратную и обратную совместимость.

struct Если аргумент размера (lpInstanceInfoSize) соответствует размеру известной версии LocalDBInstanceInfostruct, возвращается эта версияstruct. В противном случае возвращается LOCALDB_ERROR_INVALID_PARAMETER.

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

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

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

См. также

Сведения о заголовке и версии SQL Server Express LocalDB