ITypeInfo::GetDocumentation
9/8/2008
Thismethod recupera o seqüência de caracteres documentação, nome do completo arquivo da Ajuda Nome e caminho e o identificador de contexto para o tópico da Ajuda para uma descrição tipo especificado.
Syntax
HRESULT GetDocumentation(
MEMBERID memid,
BSTR FAR* pBstrName,
BSTR FAR* pBstrDocString,
unsigned long FAR* pdwHelpContext,
BSTR FAR* pBstrHelpFile
);
Parameters
- memid
[no] Identificação do membro cuja documentação é a ser retornado.
- pBstrName
[out] Retorna um BSTR que contém o nome do item especificado. Se o chamador não precisa o item Nome, em seguida, pBstrName pode ser NULL.
- pBstrDocString
[out] Retorna um BSTR que contém o seqüência de caracteres documentação para o item especificado. Se o chamador não precisar seqüência de caracteres a documentação, em seguida, pBstrDocString pode ser NULL.
- pdwHelpContext
[out] Retorna a identificador de contexto de Ajuda associado com o item especificado. Se o chamador não precisar identificador de contexto a ' ajuda ', em seguida, pdwHelpContext pode ser NULL.
- pBstrHelpFile
[out] Retorna um BSTR que contém o nome totalmente qualificado da arquivo da Ajuda. Se o chamador não precisa de arquivo da Ajuda Nome, em seguida, pBstrHelpFile pode ser NULL.
Return Value
A seguinte tabela mostra os valores de retorno para esta função.
Valor | Descrição |
---|---|
S_OK |
O sucesso. |
STG_E_INSUFFICIENTMEMORY |
Memória insuficiente. |
E_INVALIDARG |
Um ou mais dos parâmetros é inválido. |
TYPE_E_IOERROR |
A função não pôde gravar o arquivo. |
TYPE_E_INVDATAREAD |
A função não pôde ler a partir de arquivo. |
TYPE_E_UNSUPFORMAT |
A biblioteca tipo tem um formato mais antigo. |
TYPE_E_INVALIDSTATE |
Não foi possível abrir a biblioteca tipo. |
TYPE_E_ELEMENTNOTFOUND |
O elemento não foi encontrado. |
Remarks
A função GetDocumentation Fornece acessar para a documentação para o membro especificado pelo memid parâmetro. Se o passado- memid é MEMBERID_NIL, e a documentação para a descrição tipo é retornada.
Se a descrição tipo herda descrição outro tipo, essa função é recursivo para a descrição tipo base, se necessário, para localizar o item com o identificador membro solicitado.
O chamador deve livre a BSTR Parâmetros pBstrName, pBstrDocString, e pBstrHelpFile.
Example
for (i = 0; i < utypeinfoCount; i++)
{
CHECKRESULT(ptlib->GetDocumentation(i, &bstrName, NULL, NULL, NULL));
.
.
.
SysFreeString(bstrName);
}
Requirements
Header | oaidl.h, oaidl.idl |
Library | oleaut32.lib, uuid.lib |
Windows Embedded CE | Windows CE 2.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |