InstAPI.GetSQLServiceByName(String, SQL_SVCS, StringBuilder, UInt32) Method

Definition

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

public:
 static bool GetSQLServiceByName(System::String ^ instanceName, Microsoft::SqlServer::SQL_SVCS product, System::Text::StringBuilder ^ serviceName, System::UInt32 % bufferSize);
public static bool GetSQLServiceByName (string instanceName, Microsoft.SqlServer.SQL_SVCS product, System.Text.StringBuilder serviceName, ref uint bufferSize);
static member GetSQLServiceByName : string * Microsoft.SqlServer.SQL_SVCS * System.Text.StringBuilder * uint32 -> bool
Public Shared Function GetSQLServiceByName (instanceName As String, product As SQL_SVCS, serviceName As StringBuilder, ByRef bufferSize As UInteger) As Boolean

Parameters

instanceName
String

A String value that represents the instance name.

product
SQL_SVCS

The SQL service.

serviceName
StringBuilder

A string input for ServiceName.

bufferSize
UInt32

A pointer to a DWORD value to supply the length of the buffer. Returns the required length if the supplied buffer is too small.

Returns

true if the SQL Service is sorted by Name; otherwise, false.

Applies to