InstAPI.GetInstRootDirPathByID(INST_ID, StringBuilder, UInt32) Method

Definition

Retrieves the directory path root for a specific SQL instance by the given instance ID.

public:
 static bool GetInstRootDirPathByID(Microsoft::SqlServer::INST_ID ^ instanceID, System::Text::StringBuilder ^ directoryPath, System::UInt32 % bufferSize);
public static bool GetInstRootDirPathByID (Microsoft.SqlServer.INST_ID instanceID, System.Text.StringBuilder directoryPath, ref uint bufferSize);
static member GetInstRootDirPathByID : Microsoft.SqlServer.INST_ID * System.Text.StringBuilder * uint32 -> bool
Public Shared Function GetInstRootDirPathByID (instanceID As INST_ID, directoryPath As StringBuilder, ByRef bufferSize As UInteger) As Boolean

Parameters

instanceID
INST_ID

A pointer to the instance ID of the relevant instance.

directoryPath
StringBuilder

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

Applies to