Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Returns all SQL Server Express LocalDB instances with the given version.
Header file: sqlncli.h
Syntax
#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
);
Parameters
pInstanceNames
[Output] When this function returns, contains the names of both named and default LocalDB instances on the user’s workstation.lpdwNumberOfInstances
[Input/Output] On input, contains the number of slots for instance names in the pInstanceNames buffer. On output, contains the number of LocalDB instances found on the user’s workstation.
Returns
S_OK
The function succeeded.LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB is not installed on the computer.LOCALDB_ERROR_INVALID_PARAMETER
One or more specified input parameters are invalid.LOCALDB_ERROR_INSUFFICIENT_BUFFER
The input buffer is too short, and truncation was not requested.LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG
The path where the instance should be stored is longer than MAX_PATH.LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY
An instance registry cannot be accessed.LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT
An instance configuration is corrupted.LOCALDB_ERROR_INTERNAL_ERROR
An unexpected error occurred. See the event log for details.
Remarks
For a code sample that uses LocalDB API, see SQL Server Express LocalDB Reference.