Função ReportSMStatusMessage

A ReportSMSStatusMessage função, em Configuration Manager, envia um objeto de mensagem de status para o sistema de status Configuration Manager e, em seguida, desaloca o objeto.

Sintaxe

[C/C++]  
typedef DWORD (WINAPI *PROC_REPORTSMSSTATUSMESSAGE)  
(  
      HANDLE hStatusMessageObject,  
      LPCSTR pszComponentName,  
      LPCSTR pszSiteCode,  
      LPCSTR pszTopLevelSiteCode  
);  

Parâmetros

hStatusMessageObject
Tipo de dados: HANDLE

Qualificadores: [dentro, fora]

Manipule para o objeto de mensagem de status. Na entrada, forneça o identificador recuperado por CreateSMSStatusMessage. No retorno bem-sucedido da função, esse parâmetro contém o identificador para o objeto desalocado.

O comportamento dessa função é indefinido para identificadores inválidos e gera uma exceção de violação de acesso. Portanto, verifique se você fornece um identificador válido para este parâmetro. Consulte os comentários.

pszComponentName
Tipo de dados: LPCSTR

Qualificadores: [in]

Ponteiro para o nome do componente que relata a mensagem de status. Esse nome é um nome de componente ASCII encerrado em nulo. Ele aparece no Visualizador de Mensagens de Status na coluna Componente e em Windows NT Visualizador de Eventos na coluna Categoria. Para obter mais informações, confira a seção Comentários mais adiante neste tópico.

pszSiteCode
Tipo de dados: LPCSTR

Qualificadores: [in]

Ponteiro para o código do site Configuration Manager para o site ao qual relatar a mensagem de status. O código é um código ASCII encerrado em nulo que tem exatamente três caracteres. Como alternativa, você pode definir esse parâmetro como null. Para obter mais informações, confira a seção Comentários mais adiante neste tópico.

pszTopLevelSiteCode
Tipo de dados: LPCSTR

Qualificadores: [in]

Ponteiro para o código do site Configuration Manager para o site mais alto da hierarquia à qual a mensagem pode ser replicada. O código é um código ASCII encerrado em nulo. Como alternativa, você pode definir esse parâmetro como null. Para obter mais informações, confira a seção Comentários mais adiante neste tópico.

Return Values

Essa função retorna um dos valores na tabela a seguir.

Valor	Descrição
SMSSTATMSG_SUCCESS	O objeto foi enviado com êxito ao sistema de status Configuration Manager.
SMSSTATMSG_OUT_OF_MEMORY	Essa função não conseguiu alocar memória suficiente para enviar o objeto ao sistema de status Configuration Manager.
SMSSTATMSG_ERROR_INVALID_COMPONENT_NAME	O chamador forneceu null ou uma cadeia de caracteres que excedeu SMSSTATMSG_MAX_COMPONENT_NAME_LENGTH caracteres de comprimento para o pszComponentName parâmetro.
SMSSTATMSG_ERROR_INVALID_SITE_CODE	O chamador forneceu uma cadeia de caracteres inválida não NULL para pszSiteCode.
SMSSTATMSG_ERROR_UNKNOWN	A função encontrou um erro desconhecido ao tentar enviar o objeto para o sistema de status Configuration Manager.
SMSSTATMSG_ERROR_INVALID_TOP_LEVEL_SC	O chamador forneceu uma cadeia de caracteres inválida não NULL para pszTopLevelSiteCode.
SMSSTATMSG_ERROR_NOT_SMS_CLIENT	Essa função falhou ao enviar o objeto para o sistema de status Configuration Manager porque o Configuration Manager software cliente não está instalado corretamente neste computador.

Comentários

Smscstat.h inclui o seguinte #define para chamar ReportSMSStatusMessage usando a função GetProcAddressWin32 .

#define PROCNAME_REPORTSMSSTATUSMESSAGE "ReportSMSStatusMessage"  

Ao chamar essa função, use o hStatusMessageObject parâmetro para fornecer um identificador para a mensagem de status relatar. Quando essa função retorna, o objeto recuperado tem a garantia de ser desalocado, independentemente do sucesso da função. Se a função não tiver êxito e você quiser que seu aplicativo tente novamente, crie uma nova mensagem de status antes de chamar ReportSMSStatusMessage.

Use o pszComponentName parâmetro dessa função para fornecer um nome para o componente que está relatando a mensagem de status. Esse nome não é localizável para outros idiomas, pois o administrador do Configuration Manager cria consultas e regras de filtro baseadas no nome do componente. Isso ajuda o administrador a recuperar rapidamente suas mensagens de status específicas e a configurar Configuration Manager para lidar com essas mensagens de status de maneiras especiais.

pszSiteCode No parâmetro, forneça o código do site Configuration Manager para o qual enviar a mensagem. O código deve ser para um dos sites aos quais o cliente Configuration Manager pertence atualmente. Geralmente, você deve fornecer null para esse parâmetro, para indicar que a mensagem de status deve ser relatada a todos os sites Configuration Manager aos quais o cliente Configuration Manager pertence.

O sistema de status interrompe a replicação no site indicado por pszTopLevelSiteCode não importa como o administrador configurou as regras de replicação. Geralmente, você deve especificar null para esse parâmetro, para indicar que não há código de site de nível superior e que a mensagem é gratuita para replicar todo o caminho até a parte superior da hierarquia. No entanto, se houver um motivo para impedir que a replicação passe por determinado site, você poderá fornecer o código do site desse site usando o pszTopLevelSiteCode parâmetro.

Requisitos

Smscstat.dll.

Requisitos de runtime

Para obter mais informações, consulte Configuration Manager Requisitos de Runtime do Cliente.

Requisitos de desenvolvimento

Para obter mais informações, consulte Configuration Manager Requisitos de desenvolvimento do cliente.

Confira também

Funções de mensagem de statusSMSCSTAT.DLL