IVsWritableSettingsStore::GetStringOrDefault Method (String^, String^, String^, String^)

 

Returns a string type property value or a given default string.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)

int GetStringOrDefault(
	String^ collectionPath,
	String^ propertyName,
	String^ defaultValue,
	[OutAttribute] String^% value
)

Parameters

collectionPath
Type: System::String^

[in] The path of the collection.

propertyName
Type: System::String^

[in] The property name.

defaultValue
Type: System::String^

[in] The default value to return if the property is not set.

value
Type: System::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.

Return Value

Type: System::Int32

Returns S_OK if the property was returned, S_FALSE if the property does not exist, or E_INVALIDARG if the property type is not an integer.

Return to top
Show: