Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

InstAPI Class

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

System.Object
  Microsoft.SqlServer.InstAPI

Namespace:  Microsoft.SqlServer
Assembly:  Microsoft.SqlServer.Instapi (in Microsoft.SqlServer.Instapi.dll)
public static class InstAPI

The InstAPI type exposes the following members.

  NameDescription
Public methodStatic memberGetCOMPathRetrieves the COM path for the InstAPI class.
Public methodStatic memberGetInstanceIDFromFTSAppRetrieves the instance ID from a full-text search (FTS) application.
Public methodStatic memberGetInstanceIDFromServiceRetrieves the instance ID from the full-text search (FTS) service.
Public methodStatic memberGetInstanceNameFromFTSAppRetrieves the instance name from the full-text search (FTS) application.
Public methodStatic memberGetInstanceNameFromID(INST_ID)Retrieves an instance name from an ID.
Public methodStatic memberGetInstanceNameFromID(INST_ID, StringBuilder, UInt32) Obsolete. Retrieves an instance name from an ID.
Public methodStatic memberGetInstanceNameFromServerInstanceNameRetrieves the instance name from the server instance name.
Public methodStatic memberGetInstanceNameFromServiceRetrieves the instance name from a service.
Public methodStatic memberGetInstancePipeByIDRetrieves the named pipe path of an instance by the given instance ID.
Public methodStatic memberGetInstancePipeByNameRetrieves the named pipe path of an instance by the given friendly name.
Public methodStatic memberGetInstRegPathByIDRetrieves the registry path for a specific SQL instance and service by the given instance ID.
Public methodStatic memberGetInstRegPathByNameRetrieves the registry path for a specific SQL instance and service by the given friendly instance name.
Public methodStatic memberGetInstRootDirPathByIDRetrieves the directory path root for a specific SQL instance by the given instance ID.
Public methodStatic memberGetInstRootRegPathByIDRetrieves the registry path by ID.
Public methodStatic memberGetMajorVersionSharedCodePathRetrieves the major version shared by the code path for the SQL server.
Public methodStatic memberGetRegKeyAccessMaskRetrieves a given registry path and modifies the given access mask to find the key in the correct location.
Public methodStatic memberGetSQLBinPathByInstIDRetrieves the program file root directory for the SQL Server service by the given instance ID.
Public methodStatic memberGetSQLDataRootByInstIDRetrieves the SQL data file root directory by the given instance ID.
Public methodStatic memberGetSQLDataRootByInstNameRetrieves the SQL data file root directory by the given friendly instance name.
Public methodStatic memberGetSQLInstanceRegStringByIDRetrieves a registry string from an instance specific registry tree by the given instance ID, the subtree, and the name of the value.
Public methodStatic memberGetSQLReplicationRegPathShows a copy of the registry path for the SQL.
Public methodStatic memberGetSQLRootRegPathRetrieves the registry root for a SQL Server.
Public methodStatic memberGetSQLServerByID(String, INST_ID)Retrieves the server name of a SQL instance by the given instance ID and host name.
Public methodStatic memberGetSQLServerByID(String, INST_ID, StringBuilder, UInt32) Obsolete. Retrieves the server name of a SQL instance by the given instance ID and host name.
Public methodStatic memberGetSQLServerByName(String, String)Sorts the list of SQL servers by name using a Boolean expression.
Public methodStatic memberGetSQLServerByName(String, String, StringBuilder, UInt32) Obsolete. Sorts the list of SQL servers by name using a Boolean expression.
Public methodStatic memberGetSQLServiceByIDUses a Boolean expression to sort SQL Service by specified ID.
Public methodStatic memberGetSQLServiceByNameUses a Boolean expression to sort SQL Service by specified Name.
Public methodStatic memberGetSQLToolsDirPathRetrieves the directory root for a SQL Server tools installation.
Public methodStatic memberGetSQLToolsRegPathRetrieves the registry root for the SQL Server tool.
Public methodStatic memberGetSQLVerSpecificRegStringIndicates the specific registry string value for SQL Server.
Public methodStatic memberGetSvcBinPathByIDRetrieves the program file root directory for a specific service by the given service type and the instance ID.
Public methodStatic memberGetSvcBinPathByInstNameRetrieves the program file root directory for the SQL Server service by the given friendly instance name.
Public methodStatic memberGetSvcBinPathByNameRetrieves the program file root directory for a specific service by the given service type and the friendly instance name.
Public methodStatic memberGetSvcInstanceIDFromName(String, SQL_SVCS)Retrieves the instance ID of an instance from the given friendly name.
Public methodStatic memberGetSvcInstanceIDFromName(String, SQL_SVCS, INST_ID) Obsolete. Retrieves the instance ID of an instance from the given friendly name.
Public methodStatic memberGetSvcInstanceRegStringByNameRetrieves a registry string from an instance specific registry tree by the given friendly instance name, subtree, and the value name.
Public methodStatic memberGetSvcInstRootDirPathByNameRetrieves the directory path root for a specific SQL instance by the given friendly instance name.
Public methodStatic memberGetSvcInstRootRegPathByNameRetrieves the registry path root for a specific SQL instance by the given friendly instance name.
Public methodStatic memberGetVerSpecificRootDirPathRetrieves the version specific (not instance specific) directory root for SQL Server.
Public methodStatic memberGetVerSpecificRootRegPathRetrieves the version specific (not instance specific) registry root for SQL Server.
Public methodStatic memberIsDefaultInstanceIDRetrieves a value that indicates the default instance ID.
Public methodStatic memberIsDefaultInstanceNameRetrieves a value that indicates the default instance name.
Public methodStatic memberIsNameAgentServiceDetermines whether a string is a valid SQL Agent service name.
Public methodStatic memberIsNameSQLServiceDetermines whether a string is a valid SQL service name.
Top
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.