InstAPI Class

 

Contains methods that are used to resolve friendly names with unique instance IDs.

Namespace:   Microsoft.SqlServer
Assembly:  Microsoft.SqlServer.Instapi (in Microsoft.SqlServer.Instapi.dll)

System.Object
  Microsoft.SqlServer.InstAPI

public static class InstAPI

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticGetCOMPath(StringBuilder, UInt32)

Retrieves the COM path for the InstAPI class.

System_CAPS_pubmethodSystem_CAPS_staticGetInstanceIDFromFTSApp(String, INST_ID)

Retrieves the instance ID from a full-text search (FTS) application.

System_CAPS_pubmethodSystem_CAPS_staticGetInstanceIDFromService(String, INST_ID)

Retrieves the instance ID from the full-text search (FTS) service.

System_CAPS_pubmethodSystem_CAPS_staticGetInstanceNameFromFTSApp(String, StringBuilder, UInt32)

Retrieves the instance name from the full-text search (FTS) application.

System_CAPS_pubmethodSystem_CAPS_staticGetInstanceNameFromID(INST_ID)

Retrieves an instance name from an ID.

System_CAPS_pubmethodSystem_CAPS_staticGetInstanceNameFromID(INST_ID, StringBuilder, UInt32)

Obsolete.Retrieves an instance name from an ID.

System_CAPS_pubmethodSystem_CAPS_staticGetInstanceNameFromServerInstanceName(String)

Retrieves the instance name from the server instance name.

System_CAPS_pubmethodSystem_CAPS_staticGetInstanceNameFromService(String, StringBuilder, UInt32)

Retrieves the instance name from a service.

System_CAPS_pubmethodSystem_CAPS_staticGetInstancePipeByID(INST_ID, StringBuilder, UInt32)

Retrieves the named pipe path of an instance by the given instance ID.

System_CAPS_pubmethodSystem_CAPS_staticGetInstancePipeByName(String, StringBuilder, UInt32)

Retrieves the named pipe path of an instance by the given friendly name.

System_CAPS_pubmethodSystem_CAPS_staticGetInstRegPathByID(INST_ID, SQL_SVCS, StringBuilder, UInt32)

Retrieves the registry path for a specific SQL instance and service by the given instance ID.

System_CAPS_pubmethodSystem_CAPS_staticGetInstRegPathByName(String, SQL_SVCS, StringBuilder, UInt32)

Retrieves the registry path for a specific SQL instance and service by the given friendly instance name.

System_CAPS_pubmethodSystem_CAPS_staticGetInstRootDirPathByID(INST_ID, StringBuilder, UInt32)

Retrieves the directory path root for a specific SQL instance by the given instance ID.

System_CAPS_pubmethodSystem_CAPS_staticGetInstRootRegPathByID(INST_ID, StringBuilder, UInt32)

Retrieves the registry path by ID.

System_CAPS_pubmethodSystem_CAPS_staticGetMajorVersionSharedCodePath()

Retrieves the major version shared by the code path for the SQL server.

System_CAPS_pubmethodSystem_CAPS_staticGetRegKeyAccessMask(String, UInt32, UInt32)

Retrieves a given registry path and modifies the given access mask to find the key in the correct location.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLBinPathByInstID(INST_ID, StringBuilder, UInt32)

Retrieves the program file root directory for the SQL Server service by the given instance ID.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLDataRootByInstID(INST_ID, StringBuilder, UInt32)

Retrieves the SQL data file root directory by the given instance ID.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLDataRootByInstName(String, StringBuilder, UInt32)

Retrieves the SQL data file root directory by the given friendly instance name.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLInstanceRegStringByID(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.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLReplicationRegPath(StringBuilder, UInt32)

Shows a copy of the registry path for the SQL.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLRootRegPath(StringBuilder, UInt32)

Retrieves the registry root for a SQL Server.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLServerByID(String, INST_ID)

Retrieves the server name of a SQL instance by the given instance ID and host name.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLServerByID(String, INST_ID, StringBuilder, UInt32)

Obsolete.Retrieves the server name of a SQL instance by the given instance ID and host name.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLServerByName(String, String)

Sorts the list of SQL servers by name using a Boolean expression.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLServerByName(String, String, StringBuilder, UInt32)

Obsolete.Sorts the list of SQL servers by name using a Boolean expression.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLServiceByID(INST_ID, SQL_SVCS, StringBuilder, UInt32)

Uses a Boolean expression to sort SQL Service by specified ID.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLServiceByName(String, SQL_SVCS, StringBuilder, UInt32)

Uses a Boolean expression to sort SQL Service by specified Name.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLToolsDirPath(StringBuilder, UInt32)

Retrieves the directory root for a SQL Server tools installation.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLToolsRegPath(StringBuilder, UInt32)

Retrieves the registry root for the SQL Server tool.

System_CAPS_pubmethodSystem_CAPS_staticGetSQLVerSpecificRegString(String, String, StringBuilder, UInt32)

Indicates the specific registry string value for SQL Server.

System_CAPS_pubmethodSystem_CAPS_staticGetSvcBinPathByID(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.

System_CAPS_pubmethodSystem_CAPS_staticGetSvcBinPathByInstName(String, SQL_SVCS, StringBuilder, UInt32)

Retrieves the program file root directory for the SQL Server service by the given friendly instance name.

System_CAPS_pubmethodSystem_CAPS_staticGetSvcBinPathByName(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.

System_CAPS_pubmethodSystem_CAPS_staticGetSvcInstanceIDFromName(String, SQL_SVCS)

Retrieves the instance ID of an instance from the given friendly name.

System_CAPS_pubmethodSystem_CAPS_staticGetSvcInstanceIDFromName(String, SQL_SVCS, INST_ID)

Obsolete.Retrieves the instance ID of an instance from the given friendly name.

System_CAPS_pubmethodSystem_CAPS_staticGetSvcInstanceRegStringByName(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.

System_CAPS_pubmethodSystem_CAPS_staticGetSvcInstRootDirPathByName(String, SQL_SVCS, StringBuilder, UInt32)

Retrieves the directory path root for a specific SQL instance by the given friendly instance name.

System_CAPS_pubmethodSystem_CAPS_staticGetSvcInstRootRegPathByName(String, SQL_SVCS, StringBuilder, UInt32)

Retrieves the registry path root for a specific SQL instance by the given friendly instance name.

System_CAPS_pubmethodSystem_CAPS_staticGetVerSpecificRootDirPath(StringBuilder, UInt32)

Retrieves the version specific (not instance specific) directory root for SQL Server.

System_CAPS_pubmethodSystem_CAPS_staticGetVerSpecificRootRegPath(StringBuilder, UInt32)

Retrieves the version specific (not instance specific) registry root for SQL Server.

System_CAPS_pubmethodSystem_CAPS_staticIsDefaultInstanceID(INST_ID)

Retrieves a value that indicates the default instance ID.

System_CAPS_pubmethodSystem_CAPS_staticIsDefaultInstanceName(String)

Retrieves a value that indicates the default instance name.

System_CAPS_pubmethodSystem_CAPS_staticIsNameAgentService(String)

Determines whether a string is a valid SQL Agent service name.

System_CAPS_pubmethodSystem_CAPS_staticIsNameSQLService(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.

Return to top
Show: