IVsHelpAttributeList.GetAttributeValue(Int32, ATTRVALUETYPE, String) Method

Definition

Get the attribute's value by index. Also sets the position for other methods not specifying an index.

public:
 int GetAttributeValue(int index, Microsoft::VisualStudio::Shell::Interop::ATTRVALUETYPE type, [Runtime::InteropServices::Out] System::String ^ % pbstrValue);
int GetAttributeValue(int index, Microsoft::VisualStudio::Shell::Interop::ATTRVALUETYPE type, [Runtime::InteropServices::Out] std::wstring const & & pbstrValue);
public int GetAttributeValue (int index, Microsoft.VisualStudio.Shell.Interop.ATTRVALUETYPE type, out string pbstrValue);
abstract member GetAttributeValue : int * Microsoft.VisualStudio.Shell.Interop.ATTRVALUETYPE * string -> int
Public Function GetAttributeValue (index As Integer, type As ATTRVALUETYPE, ByRef pbstrValue As String) As Integer

Parameters

index
Int32

[in] Index indicating the position of the attribute in the list.

type
ATTRVALUETYPE

[in] An ATTRVALUETYPE indicating the type of the attribute: VSHAL_Real for the actual attribute, VSHAL_Display for the display attribute.

pbstrValue
String

[out] Pointer to a string containing the attribute value.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsHelpAttributeList::GetAttributeValue(  
   [in] int index,   
   [in] ATTRVALUETYPE type,   
   [out] BSTR *pbstrValue  
);  

Applies to