InstAPI.GetInstancePipeByName(String, StringBuilder, UInt32) Method

  • Reference

Definition

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

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

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

Parameters

instanceName
String

A String value that represents the instance name.

instancePipe
StringBuilder

A pointer to a buffer to receive the pipe 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