InstAPI.GetInstRegPathByID(INST_ID, SQL_SVCS, 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 registry path for a specific SQL instance and service by the given instance ID.
public:
static bool GetInstRegPathByID(Microsoft::SqlServer::INST_ID ^ instanceID, Microsoft::SqlServer::SQL_SVCS product, System::Text::StringBuilder ^ registryPath, System::UInt32 % bufferSize);
public static bool GetInstRegPathByID (Microsoft.SqlServer.INST_ID instanceID, Microsoft.SqlServer.SQL_SVCS product, System.Text.StringBuilder registryPath, ref uint bufferSize);
static member GetInstRegPathByID : Microsoft.SqlServer.INST_ID * Microsoft.SqlServer.SQL_SVCS * System.Text.StringBuilder * uint32 -> bool
Public Shared Function GetInstRegPathByID (instanceID As INST_ID, product As SQL_SVCS, registryPath As StringBuilder, ByRef bufferSize As UInteger) As Boolean
Parameters
- instanceID
- INST_ID
A pointer to the instance ID of the relevant instance.
- product
- SQL_SVCS
The SQL service.
- registryPath
- 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
true
if the call succeeded; otherwise, false
.