Função ReportSMSStatusMessage

A função, no Configuration Manager, envia um objeto de mensagem de status para o sistema de status do Configuration Manager e, em seguida, ReportSMSStatusMessage negocia 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: [in, out]

Manipular para o objeto de mensagem de status. Na entrada, fornece o handle recuperado por CreateSMSStatusMessage. No retorno bem-sucedido da função, este parâmetro contém o identificador para o objeto alocado.

O comportamento dessa função é indefinido para alças inválidas e lança uma exceção de violação de acesso. Portanto, certifique-se de fornecer uma alça válida para esse 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 nulo. Ele aparece no Visualizador de Mensagens de Status na coluna Componente e Windows NT Visualizador de Eventos na coluna Categoria. Para obter mais informações, consulte a seção Comentários posteriormente neste tópico.

pszSiteCode
Tipo de dados: LPCSTR

Qualificadores: [in]

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

pszTopLevelSiteCode
Tipo de dados: LPCSTR

Qualificadores: [in]

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

Return Values

Esta 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 do Configuration Manager.
SMSSTATMSG_OUT_OF_MEMORY Essa função falhou ao alocar memória suficiente para enviar o objeto ao sistema de status do Configuration Manager.
SMSSTATMSG_ERROR_INVALID_COMPONENT_NAME O chamador fornecido ou uma cadeia de null 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 NULO para pszSiteCode .
SMSSTATMSG_ERROR_UNKNOWN A função encontrou um erro desconhecido ao tentar enviar o objeto ao sistema de status do Configuration Manager.
SMSSTATMSG_ERROR_INVALID_TOP_LEVEL_SC O chamador forneceu uma cadeia de caracteres inválida não NULO para pszTopLevelSiteCode .
SMSSTATMSG_ERROR_NOT_SMS_CLIENT Essa função falhou ao enviar o objeto para o sistema de status do Configuration Manager porque o software cliente do Configuration Manager não está instalado corretamente neste computador.

Comentários

Smscstat.h inclui o seguinte #define para ReportSMSStatusMessage chamada usando a função Win32 GetProcAddress .

#define PROCNAME_REPORTSMSSTATUSMESSAGE "ReportSMSStatusMessage"  

Ao chamar essa função, use o hStatusMessageObject parâmetro para fornecer uma alça para a mensagem de status relatar. Quando essa função retorna, o objeto recuperado é garantido para ser alocado, 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, porque 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 o Configuration Manager para lidar com essas mensagens de status de maneiras especiais.

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

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

Requirements

Smscstat.dll.

Requisitos de tempo de execução

Para obter mais informações, consulte Configuration Manager Client Runtime Requirements.

Requisitos de desenvolvimento

Para obter mais informações, consulte Configuration Manager Client Development Requirements.

Confira também

SMSCSTAT.DLL Funções de Mensagem de Status