InstAPI.GetSQLToolsDirPath(StringBuilder, UInt32) Method

Reference

Definition

Namespace:: Microsoft.SqlServer

Assembly:: Microsoft.SqlServer.Instapi.dll

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 directory root for a SQL Server tools installation.

public:
 static bool GetSQLToolsDirPath(System::Text::StringBuilder ^ directoryPath, System::UInt32 % bufferSize);

public static bool GetSQLToolsDirPath (System.Text.StringBuilder directoryPath, ref uint bufferSize);

static member GetSQLToolsDirPath : System.Text.StringBuilder * uint32 -> bool

Public Shared Function GetSQLToolsDirPath (directoryPath As StringBuilder, ByRef bufferSize As UInteger) As Boolean

Parameters

directoryPath: StringBuilder

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

Returns TRUE if the call succeeded; returns FALSE if the call fails.

Remarks

Be aware that there is only one tools installation per version of SQL Server, not one tools installation per instance.

Applies to