IVsSettingsStore.GetString Method
Returns a string type property value.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assemblies: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)
Syntax
'Declaration
Function GetString ( _
collectionPath As String, _
propertyName As String, _
<OutAttribute> ByRef value As String _
) As Integer
int GetString(
string collectionPath,
string propertyName,
out string value
)
int GetString(
[InAttribute] String^ collectionPath,
[InAttribute] String^ propertyName,
[OutAttribute] String^% value
)
abstract GetString :
collectionPath:string *
propertyName:string *
value:string byref -> int
function GetString(
collectionPath : String,
propertyName : String,
value : String
) : int
Parameters
collectionPath
Type: String[in] The path of the collection.
propertyName
Type: String[in] The property name.
value
Type: 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: 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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.