Compartilhar via


Função FormatPropertyInstance

A função FormatPropertyInstance formata os dados da instância de propriedade usando o formatador genérico que o Monitor de Rede fornece.

Sintaxe

DWORD WINAPIV FormatPropertyInstance(
  _Inout_ LPPROPERTYINST lpPropertyInst
);

Parâmetros

lpPropertyInst [in, out]

Um ponteiro para uma estrutura PROPERTYINST que contém os dados da instância.

Na entrada, o formatador genérico usa os dados da instância de um dos membros da união PROPERTYINST e converte esses dados em uma cadeia de caracteres formatada predefinida.

Na saída, o formatador genérico define o membro szPropertyText da estrutura PROPERTYINST como um ponteiro para a cadeia de caracteres formatada.

Valor retornado

Se a função for bem-sucedida, o valor retornado será NMERR_SUCCESS.

Se a função não for bem-sucedida, o valor retornado será um código de erro de NMerr.h.

Comentários

A DLL do analisador chama indiretamente a função FormatPropertyInstance quando o formatador genérico é necessário para formatar dados para exibição no painel de detalhes da interface do usuário do Monitor de Rede. Para chamar FormatPropertyInstance , especifique-o no membro InstanceData da estrutura PROPERTYINFO quando você definir a propriedade.

Observação

O analisador não reconhece qual função é chamada quando deve formatar uma instância de uma propriedade. A função pode ser FormatPropertyInstance ou uma função de formato personalizado definida pelo analisador. O analisador chama qualquer função de formato especificada pelo membro InstanceData da estrutura PROPERTYINFO para a propriedade .

Para obter mais informações e um exemplo de como implementar propriedades de formato, consulte Implementando FormatProperties. Para obter mais informações sobre como o formatador genérico formata diferentes tipos de dados, consulte Saída do Formatador Genérico.

Requisitos

Requisito Valor
Cliente mínimo com suporte
Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte
Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho
Netmon.h
Biblioteca
Nmapi.lib
DLL
Nmapi.dll

Confira também

PROPERTYINFO

PROPERTYINST