IVsWritableSettingsStore.SetString(String, String, String) Method

Definition

Sets the value of a string property. If the previous data type of the property is not SettingsType_String, this method overwrites it. If the property does not exist, it creates one.

public:
 int SetString(System::String ^ collectionPath, System::String ^ propertyName, System::String ^ value);
public:
 int SetString(Platform::String ^ collectionPath, Platform::String ^ propertyName, Platform::String ^ value);
int SetString(std::wstring const & collectionPath, std::wstring const & propertyName, std::wstring const & value);
public int SetString (string collectionPath, string propertyName, string value);
abstract member SetString : string * string * string -> int
Public Function SetString (collectionPath As String, propertyName As String, value As String) As Integer

Parameters

collectionPath
String

[in] The path to the collection.

propertyName
String

[in] The property.

value
String

[in] The value.

Returns

Returns S_OK if the value was set. If the collection does not exist, the method returns E_INVALIDARG.

Remarks

This method is safe to access from any thread.

Applies to