IVsObjectBrowserDescription2.AddDescriptionText Method
Adds descriptive text for an object browser object.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function AddDescriptionText ( _
pText As String, _
obdSect As VSOBDESCRIPTIONSECTION, _
pHyperJump As VSOBJECTINFO() _
) As Integer
int AddDescriptionText(
string pText,
VSOBDESCRIPTIONSECTION obdSect,
VSOBJECTINFO[] pHyperJump
)
int AddDescriptionText(
[InAttribute] String^ pText,
[InAttribute] VSOBDESCRIPTIONSECTION obdSect,
[InAttribute] array<VSOBJECTINFO>^ pHyperJump
)
abstract AddDescriptionText :
pText:string *
obdSect:VSOBDESCRIPTIONSECTION *
pHyperJump:VSOBJECTINFO[] -> int
function AddDescriptionText(
pText : String,
obdSect : VSOBDESCRIPTIONSECTION,
pHyperJump : VSOBJECTINFO[]
) : int
Parameters
pText
Type: String[in] Pointer to a string containing the text to add.
obdSect
Type: Microsoft.VisualStudio.Shell.Interop.VSOBDESCRIPTIONSECTION[in] Value from the VSOBDESCRIPTIONSECTION enumeration indicating the type of the object or description.
pHyperJump
Type: array<Microsoft.VisualStudio.Shell.Interop.VSOBJECTINFO[][in] Pointer to a VSOBJECTINFO structure containing information about the object being described.
Return Value
Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
You can call AddDescriptionText with OBDS_ENABLEHELP and the other arguments null to enable help commands.
COM Signature
[C++]
From vsshell.idl:
HRESULT IVsObjectBrowserDescription2::AddDescriptionText(
[in] LPCWSTR pText,
[in] VSOBDESCRIPTIONSECTION obdSect,
[in] VSOBJECTINFO *pHyperJump
);
.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.