IVsObjectBrowserDescription2.AddDescriptionText(String, VSOBDESCRIPTIONSECTION, VSOBJECTINFO[]) Метод

Определение

Добавляет описательный текст для объекта обозревателя объектов.

public:
 int AddDescriptionText(System::String ^ pText, Microsoft::VisualStudio::Shell::Interop::VSOBDESCRIPTIONSECTION obdSect, cli::array <Microsoft::VisualStudio::Shell::Interop::VSOBJECTINFO> ^ pHyperJump);
int AddDescriptionText(std::wstring const & pText, Microsoft::VisualStudio::Shell::Interop::VSOBDESCRIPTIONSECTION obdSect, std::Array <Microsoft::VisualStudio::Shell::Interop::VSOBJECTINFO> const & pHyperJump);
public int AddDescriptionText (string pText, Microsoft.VisualStudio.Shell.Interop.VSOBDESCRIPTIONSECTION obdSect, Microsoft.VisualStudio.Shell.Interop.VSOBJECTINFO[] pHyperJump);
abstract member AddDescriptionText : string * Microsoft.VisualStudio.Shell.Interop.VSOBDESCRIPTIONSECTION * Microsoft.VisualStudio.Shell.Interop.VSOBJECTINFO[] -> int
Public Function AddDescriptionText (pText As String, obdSect As VSOBDESCRIPTIONSECTION, pHyperJump As VSOBJECTINFO()) As Integer

Параметры

pText
String

[in] Указатель на строку, содержащую текст для добавления.

obdSect
VSOBDESCRIPTIONSECTION

[in] Значение из перечисления VSOBDESCRIPTIONSECTION, указывающее тип объекта или описания.

pHyperJump
VSOBJECTINFO[]

[in] Указатель на структуру VSOBJECTINFO, содержащую сведения об описываемом компоненте.

Возвращаемое значение

Int32

Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.

Комментарии

Можно вызвать AddDescriptionText с параметром OBDS_ENABLEHELP и другие аргументы null, чтобы включить команды справки.

Подпись COM

[C++]

Из всшелл. IDL:

HRESULT IVsObjectBrowserDescription2::AddDescriptionText(  
   [in] LPCWSTR pText,   
   [in] VSOBDESCRIPTIONSECTION obdSect,   
   [in] VSOBJECTINFO *pHyperJump  
);  

Применяется к