InstAPI.GetInstancePipeByID(INST_ID, StringBuilder, UInt32) 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 named pipe path of an instance by the given instance ID.
public:
static bool GetInstancePipeByID(Microsoft::SqlServer::INST_ID ^ instanceID, System::Text::StringBuilder ^ instancePipe, System::UInt32 % bufferSize);
public static bool GetInstancePipeByID (Microsoft.SqlServer.INST_ID instanceID, System.Text.StringBuilder instancePipe, ref uint bufferSize);
static member GetInstancePipeByID : Microsoft.SqlServer.INST_ID * System.Text.StringBuilder * uint32 -> bool
Public Shared Function GetInstancePipeByID (instanceID As INST_ID, instancePipe As StringBuilder, ByRef bufferSize As UInteger) As Boolean
Parameters
- instanceID
- INST_ID
A pointer to the instance ID.
- 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
true
if the call succeeded; otherwise, false
.