InstAPI.GetSvcInstanceIDFromName Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the instance ID of an instance from the given friendly name.
Overloads
GetSvcInstanceIDFromName(String, SQL_SVCS, INST_ID) |
Obsolete.
Retrieves the instance ID of an instance from the given friendly name. |
GetSvcInstanceIDFromName(String, SQL_SVCS) |
Retrieves the instance ID of an instance from the given friendly name. |
GetSvcInstanceIDFromName(String, SQL_SVCS, INST_ID)
Caution
This overload is obsolete; use GetSvcInstanceIDFromName(instanceName, service), instead.
Retrieves the instance ID of an instance from the given friendly name.
public:
static bool GetSvcInstanceIDFromName(System::String ^ instanceName, Microsoft::SqlServer::SQL_SVCS product, Microsoft::SqlServer::INST_ID ^ instanceID);
[System.Obsolete("This overload is obsolete; use GetSvcInstanceIDFromName(instanceName, service), instead.")]
public static bool GetSvcInstanceIDFromName (string instanceName, Microsoft.SqlServer.SQL_SVCS product, Microsoft.SqlServer.INST_ID instanceID);
[<System.Obsolete("This overload is obsolete; use GetSvcInstanceIDFromName(instanceName, service), instead.")>]
static member GetSvcInstanceIDFromName : string * Microsoft.SqlServer.SQL_SVCS * Microsoft.SqlServer.INST_ID -> bool
Public Shared Function GetSvcInstanceIDFromName (instanceName As String, product As SQL_SVCS, instanceID As INST_ID) As Boolean
Parameters
- product
- SQL_SVCS
The SQL service.
- instanceID
- INST_ID
A pointer to a buffer to receive the instance ID.
Returns
true
if the call succeeded; otherwise, false
.
- Attributes
Applies to
GetSvcInstanceIDFromName(String, SQL_SVCS)
Retrieves the instance ID of an instance from the given friendly name.
public:
static Microsoft::SqlServer::INST_ID ^ GetSvcInstanceIDFromName(System::String ^ instanceName, Microsoft::SqlServer::SQL_SVCS product);
public static Microsoft.SqlServer.INST_ID GetSvcInstanceIDFromName (string instanceName, Microsoft.SqlServer.SQL_SVCS product);
static member GetSvcInstanceIDFromName : string * Microsoft.SqlServer.SQL_SVCS -> Microsoft.SqlServer.INST_ID
Public Shared Function GetSvcInstanceIDFromName (instanceName As String, product As SQL_SVCS) As INST_ID
Parameters
- product
- SQL_SVCS
The SQL service.
Returns
The instance ID of an instance from the given friendly name.