Compartilhar via

Método ICreateTypeInfo::SetFuncDocString (oaidl.h)

  • Artigo

Define a cadeia de caracteres de documentação para a função com o índice especificado.

Sintaxe

HRESULT SetFuncDocString(
  [in] UINT     index,
  [in] LPOLESTR szDocString
);

Parâmetros

[in] index

O índice da função.

[in] szDocString

A cadeia de caracteres de documentação.

Retornar valor

Esse método pode retornar um desses valores.

Código de retorno Descrição
S_OK
Êxito.
E_INVALIDARG
Um ou mais argumentos não são válidos.
E_OUTOFMEMORY
Memória insuficiente para concluir a operação.
E_ACCESSDENIED
 Não é possível gravar no destino.
STG_E_INSUFFICIENTMEMORY
Memória insuficiente para concluir a operação.
TYPE_E_ELEMENTNOTFOUND
 O elemento não pode ser encontrado.

Comentários

A cadeia de caracteres de documentação é uma breve descrição da função destinada a ser usada por ferramentas como navegadores de tipo. SetFuncDocString só precisa ser usado uma vez para cada propriedade, pois todas as funções do acessador de propriedade são identificadas por um nome.

Requisitos

Requisito Valor
Plataforma de Destino Windows
Cabeçalho oaidl.h

Confira também

Icreatetypeinfo