InstAPI.GetSQLInstanceRegStringByID 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 a registry string from an instance specific registry tree by the given instance ID, the subtree, and the name of the value.
public:
static bool GetSQLInstanceRegStringByID(Microsoft::SqlServer::INST_ID ^ instanceID, System::String ^ registryPath, System::String ^ valueName, System::Text::StringBuilder ^ data, System::UInt32 % bufferSize);public static bool GetSQLInstanceRegStringByID (Microsoft.SqlServer.INST_ID instanceID, string registryPath, string valueName, System.Text.StringBuilder data, ref uint bufferSize);static member GetSQLInstanceRegStringByID : Microsoft.SqlServer.INST_ID * string * string * System.Text.StringBuilder * uint32 -> boolPublic Shared Function GetSQLInstanceRegStringByID (instanceID As INST_ID, registryPath As String, valueName As String, data As StringBuilder, ByRef bufferSize As UInteger) As BooleanParameters
- instanceID
- INST_ID
A pointer to the instance ID of the relevant instance.
- registryPath
- String
A pointer to a buffer to receive the registry path.
- data
- StringBuilder
A pointer to a buffer to receive the string that will be retrieved.
- 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.