IVsObjectList.FillDescription(UInt32, UInt32, IVsObjectBrowserDescription2) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Solicita que o item de lista forneça o texto de descrição a ser usado no Pesquisador de objetos.
public:
int FillDescription(System::UInt32 index, System::UInt32 grfOptions, Microsoft::VisualStudio::Shell::Interop::IVsObjectBrowserDescription2 ^ pobDesc);
public:
int FillDescription(unsigned int index, unsigned int grfOptions, Microsoft::VisualStudio::Shell::Interop::IVsObjectBrowserDescription2 ^ pobDesc);
int FillDescription(unsigned int index, unsigned int grfOptions, Microsoft::VisualStudio::Shell::Interop::IVsObjectBrowserDescription2 const & pobDesc);
public int FillDescription (uint index, uint grfOptions, Microsoft.VisualStudio.Shell.Interop.IVsObjectBrowserDescription2 pobDesc);
abstract member FillDescription : uint32 * uint32 * Microsoft.VisualStudio.Shell.Interop.IVsObjectBrowserDescription2 -> int
Public Function FillDescription (index As UInteger, grfOptions As UInteger, pobDesc As IVsObjectBrowserDescription2) As Integer
Parâmetros
- index
- UInt32
no Especifica o índice do item de lista de interesse.
- grfOptions
- UInt32
no Especifica opções de descrição. Os valores são obtidos da _VSOBJDESCOPTIONS enumeração
- pobDesc
- IVsObjectBrowserDescription2
no Especifica uma IVsObjectBrowserDescription3 interface.
Retornos
Se o método for bem-sucedido, retornará S_OK. Se falhar, retornará um código de erro.
Comentários
Assinatura COM
De VSShell. idl:
HRESULT IVsObjectList::FillDescription(
[in] ULONG Index,
[in] VSOBJDESCOPTIONS grfOptions,
[in] IVsObjectBrowserDescription2 *pobDesc
);
Quando um objeto é selecionado no pesquisador de objetos, uma descrição do objeto é exibida no painel inferior (painel de descrição) da janela. O texto de descrição é criado por meio de uma série de chamadas para AddDescriptionText3 . O ambiente chamará FillDescription o index item de interesse. A chamada passa em uma IVsObjectBrowserDescription3 interface. Isso é semelhante a uma IStream interface em que você chama repetidamente AddDescriptionText3 para escrever sua descrição como uma série de elementos. Os elementos são identificados com a VSOBDESCRIPTIONSECTION enumeração.
O ambiente pode especificar, por meio de grfOptions , que você deve retornar o nome totalmente qualificado do item de índice.
Esse método também é usado como um meio alternativo de fornecer texto de dica de ferramenta no ícone do item nas ferramentas de navegação de código. Nesse cenário, o ambiente chamará inicialmente GetTipText no item de índice. Se você retornar E_NOTIMPL ou falhar a chamada, o ambiente chamará FillDescription com grfOptions definido como ODO_TOOLTIPDESC | ODO_USEFULLNAME .