InstAPI Class
Contains methods that are used to resolve friendly names with unique instance IDs.
Assembly: Microsoft.SqlServer.Instapi (in Microsoft.SqlServer.Instapi.dll)
| Name | Description | |
|---|---|---|
![]() ![]() | GetCOMPath(StringBuilder^, UInt32%) | Retrieves the COM path for the InstAPI class. |
![]() ![]() | GetInstanceIDFromFTSApp(String^, INST_ID^) | Retrieves the instance ID from a full-text search (FTS) application. |
![]() ![]() | GetInstanceIDFromService(String^, INST_ID^) | Retrieves the instance ID from the full-text search (FTS) service. |
![]() ![]() | GetInstanceNameFromFTSApp(String^, StringBuilder^, UInt32%) | Retrieves the instance name from the full-text search (FTS) application. |
![]() ![]() | GetInstanceNameFromID(INST_ID^) | Retrieves an instance name from an ID. |
![]() ![]() | GetInstanceNameFromID(INST_ID^, StringBuilder^, UInt32%) | Obsolete. Retrieves an instance name from an ID. |
![]() ![]() | GetInstanceNameFromServerInstanceName(String^) | Retrieves the instance name from the server instance name. |
![]() ![]() | GetInstanceNameFromService(String^, StringBuilder^, UInt32%) | Retrieves the instance name from a service. |
![]() ![]() | GetInstancePipeByID(INST_ID^, StringBuilder^, UInt32%) | Retrieves the named pipe path of an instance by the given instance ID. |
![]() ![]() | GetInstancePipeByName(String^, StringBuilder^, UInt32%) | Retrieves the named pipe path of an instance by the given friendly name. |
![]() ![]() | GetInstRegPathByID(INST_ID^, SQL_SVCS, StringBuilder^, UInt32%) | Retrieves the registry path for a specific SQL instance and service by the given instance ID. |
![]() ![]() | GetInstRegPathByName(String^, SQL_SVCS, StringBuilder^, UInt32%) | Retrieves the registry path for a specific SQL instance and service by the given friendly instance name. |
![]() ![]() | GetInstRootDirPathByID(INST_ID^, StringBuilder^, UInt32%) | Retrieves the directory path root for a specific SQL instance by the given instance ID. |
![]() ![]() | GetInstRootRegPathByID(INST_ID^, StringBuilder^, UInt32%) | Retrieves the registry path by ID. |
![]() ![]() | GetMajorVersionSharedCodePath() | Retrieves the major version shared by the code path for the SQL server. |
![]() ![]() | GetRegKeyAccessMask(String^, UInt32, UInt32%) | Retrieves a given registry path and modifies the given access mask to find the key in the correct location. |
![]() ![]() | GetSQLBinPathByInstID(INST_ID^, StringBuilder^, UInt32%) | Retrieves the program file root directory for the SQL Server service by the given instance ID. |
![]() ![]() | GetSQLDataRootByInstID(INST_ID^, StringBuilder^, UInt32%) | Retrieves the SQL data file root directory by the given instance ID. |
![]() ![]() | GetSQLDataRootByInstName(String^, StringBuilder^, UInt32%) | Retrieves the SQL data file root directory by the given friendly instance name. |
![]() ![]() | GetSQLInstanceRegStringByID(INST_ID^, String^, String^, StringBuilder^, UInt32%) | Retrieves a registry string from an instance specific registry tree by the given instance ID, the subtree, and the name of the value. |
![]() ![]() | GetSQLReplicationRegPath(StringBuilder^, UInt32%) | Shows a copy of the registry path for the SQL. |
![]() ![]() | GetSQLRootRegPath(StringBuilder^, UInt32%) | Retrieves the registry root for a SQL Server. |
![]() ![]() | GetSQLServerByID(String^, INST_ID^) | Retrieves the server name of a SQL instance by the given instance ID and host name. |
![]() ![]() | GetSQLServerByID(String^, INST_ID^, StringBuilder^, UInt32%) | Obsolete. Retrieves the server name of a SQL instance by the given instance ID and host name. |
![]() ![]() | GetSQLServerByName(String^, String^) | Sorts the list of SQL servers by name using a Boolean expression. |
![]() ![]() | GetSQLServerByName(String^, String^, StringBuilder^, UInt32%) | Obsolete. Sorts the list of SQL servers by name using a Boolean expression. |
![]() ![]() | GetSQLServiceByID(INST_ID^, SQL_SVCS, StringBuilder^, UInt32%) | Uses a Boolean expression to sort SQL Service by specified ID. |
![]() ![]() | GetSQLServiceByName(String^, SQL_SVCS, StringBuilder^, UInt32%) | Uses a Boolean expression to sort SQL Service by specified Name. |
![]() ![]() | GetSQLToolsDirPath(StringBuilder^, UInt32%) | Retrieves the directory root for a SQL Server tools installation. |
![]() ![]() | GetSQLToolsRegPath(StringBuilder^, UInt32%) | Retrieves the registry root for the SQL Server tool. |
![]() ![]() | GetSQLVerSpecificRegString(String^, String^, StringBuilder^, UInt32%) | Indicates the specific registry string value for SQL Server. |
![]() ![]() | GetSvcBinPathByID(INST_ID^, SQL_SVCS, StringBuilder^, UInt32%) | Retrieves the program file root directory for a specific service by the given service type and the instance ID. |
![]() ![]() | GetSvcBinPathByInstName(String^, SQL_SVCS, StringBuilder^, UInt32%) | Retrieves the program file root directory for the SQL Server service by the given friendly instance name. |
![]() ![]() | GetSvcBinPathByName(String^, SQL_SVCS, StringBuilder^, UInt32%) | Retrieves the program file root directory for a specific service by the given service type and the friendly instance name. |
![]() ![]() | GetSvcInstanceIDFromName(String^, SQL_SVCS) | Retrieves the instance ID of an instance from the given friendly name. |
![]() ![]() | GetSvcInstanceIDFromName(String^, SQL_SVCS, INST_ID^) | Obsolete. Retrieves the instance ID of an instance from the given friendly name. |
![]() ![]() | GetSvcInstanceRegStringByName(String^, SQL_SVCS, String^, String^, StringBuilder^, UInt32%) | Retrieves a registry string from an instance specific registry tree by the given friendly instance name, subtree, and the value name. |
![]() ![]() | GetSvcInstRootDirPathByName(String^, SQL_SVCS, StringBuilder^, UInt32%) | Retrieves the directory path root for a specific SQL instance by the given friendly instance name. |
![]() ![]() | GetSvcInstRootRegPathByName(String^, SQL_SVCS, StringBuilder^, UInt32%) | Retrieves the registry path root for a specific SQL instance by the given friendly instance name. |
![]() ![]() | GetVerSpecificRootDirPath(StringBuilder^, UInt32%) | Retrieves the version specific (not instance specific) directory root for SQL Server. |
![]() ![]() | GetVerSpecificRootRegPath(StringBuilder^, UInt32%) | Retrieves the version specific (not instance specific) registry root for SQL Server. |
![]() ![]() | IsDefaultInstanceID(INST_ID^) | Retrieves a value that indicates the default instance ID. |
![]() ![]() | IsDefaultInstanceName(String^) | Retrieves a value that indicates the default instance name. |
![]() ![]() | IsNameAgentService(String^) | Determines whether a string is a valid SQL Agent service name. |
![]() ![]() | IsNameSQLService(String^) | Determines whether a string is a valid SQL service name. |
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

