IVsSettingsStore.GetString(String, String, String) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assemblies:
Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assemblies:
Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assembly:
Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll

Returns a string type property value.

public:
 int GetString(System::String ^ collectionPath, System::String ^ propertyName, [Runtime::InteropServices::Out] System::String ^ % value);
int GetString(std::wstring const & collectionPath, std::wstring const & propertyName, [Runtime::InteropServices::Out] std::wstring const & & value);
public int GetString (string collectionPath, string propertyName, out string value);
abstract member GetString : string * string * string -> int
Public Function GetString (collectionPath As String, propertyName As String, ByRef value As String) As Integer

Parameters

collectionPath
String

[in] The path of the collection.

propertyName
String

[in] The property name.

value
String

[out] The value. This should be passed as an uninitialized BSTR and the method will allocate enough space to hold the value of the property. The caller should call SysFreeString to release the BSTR when it is no longer needed.

Returns

Int32

Returns S_OK if the property was returned, E_INVALIDARG if the property does not exist or if the property type is not a string.

Applies to