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

  • Reference

Definition

Namespace:
Microsoft.SqlServer
Assembly:
Microsoft.SqlServer.Instapi.dll

Retrieves the program file root directory for a specific service by the given service type and the friendly instance name.

public:
 static bool GetSvcBinPathByName(System::String ^ instanceName, Microsoft::SqlServer::SQL_SVCS product, System::Text::StringBuilder ^ directoryPath, System::UInt32 % bufferSize);
public static bool GetSvcBinPathByName (string instanceName, Microsoft.SqlServer.SQL_SVCS product, System.Text.StringBuilder directoryPath, ref uint bufferSize);
static member GetSvcBinPathByName : string * Microsoft.SqlServer.SQL_SVCS * System.Text.StringBuilder * uint32 -> bool
Public Shared Function GetSvcBinPathByName (instanceName As String, product As SQL_SVCS, directoryPath 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.

directoryPath
StringBuilder

A pointer to a buffer to receive the path.

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

Boolean

true if the call succeeded; otherwise, false.

Applies to