ReportSMSStatusMessage-funktion

Funktionen ReportSMSStatusMessage skickar i Configuration Manager ett statusmeddelandeobjekt till Configuration Manager statussystem och frigör sedan objektet.

Syntax

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

Parametrar

hStatusMessageObject
Datatyp: HANDLE

Kvalificerare: [in, ut]

Hantera till statusmeddelandeobjektet. Vid indata anger du referensen som hämtats av CreateSMSStatusMessage. Vid lyckad retur från funktionen innehåller den här parametern referensen till det frigjorda objektet.

Funktionens beteende är odefinierat för ogiltiga referenser och genererar ett undantag för åtkomstöverträdelse. Se därför till att du anger ett giltigt handtag för den här parametern. Se Kommentarer.

pszComponentName
Datatyp: LPCSTR

Kvalificerare: [in]

Pekare till namnet på komponenten som rapporterar statusmeddelandet. Det här namnet är ett ASCII-komponentnamn som avslutas med null. Den visas i Visningsprogram för statusmeddelande i kolumnen Komponent och i Windows NT Loggboken i kolumnen Kategori. Mer information finns i avsnittet Kommentarer senare i det här avsnittet.

pszSiteCode
Datatyp: LPCSTR

Kvalificerare: [in]

Pekar på Configuration Manager platskod för den plats som statusmeddelandet ska rapporteras till. Koden är en NULL-avslutad ASCII-kod som är exakt tre tecken lång. Du kan också ange den här parametern till null. Mer information finns i avsnittet Kommentarer senare i det här avsnittet.

pszTopLevelSiteCode
Datatyp: LPCSTR

Kvalificerare: [in]

Pekar på Configuration Manager platskod för den högsta platsen i hierarkin som meddelandet kan replikeras till. Koden är en NULL-avslutad ASCII-kod. Du kan också ange den här parametern till null. Mer information finns i avsnittet Kommentarer senare i det här avsnittet.

Returvärden

Den här funktionen returnerar ett av värdena i följande tabell.

Värde	Beskrivning
SMSSTATMSG_SUCCESS	Objektet har skickats till statussystemet Configuration Manager.
SMSSTATMSG_OUT_OF_MEMORY	Den här funktionen kunde inte allokera tillräckligt med minne för att skicka objektet till Configuration Manager statussystem.
SMSSTATMSG_ERROR_INVALID_COMPONENT_NAME	Anroparen angav null eller en sträng som överskred SMSSTATMSG_MAX_COMPONENT_NAME_LENGTH tecken i längd för parametern pszComponentName .
SMSSTATMSG_ERROR_INVALID_SITE_CODE	Anroparen angav en ogiltig sträng som inte är NULL för pszSiteCode.
SMSSTATMSG_ERROR_UNKNOWN	Funktionen påträffade ett okänt fel när objektet skulle skickas till Configuration Manager statussystem.
SMSSTATMSG_ERROR_INVALID_TOP_LEVEL_SC	Anroparen angav en ogiltig sträng som inte är NULL för pszTopLevelSiteCode.
SMSSTATMSG_ERROR_NOT_SMS_CLIENT	Den här funktionen kunde inte skicka objektet till Configuration Manager statussystem eftersom Configuration Manager klientprogramvaran inte är korrekt installerad på den här datorn.

Anmärkningar

Smscstat.h innehåller följande #define för att anropa ReportSMSStatusMessage med hjälp av Win32-funktionen GetProcAddress.

#define PROCNAME_REPORTSMSSTATUSMESSAGE "ReportSMSStatusMessage"  

När du anropar den här funktionen använder du parametern hStatusMessageObject för att ange ett handtag för statusmeddelandet som ska rapporteras. När den här funktionen returneras kommer det hämtade objektet garanterat att frigöras, oavsett om funktionen lyckas. Om funktionen misslyckas och du vill att programmet ska försöka igen skapar du ett nytt statusmeddelande innan du anropar ReportSMSStatusMessage.

Använd parametern för den pszComponentName här funktionen för att ange ett namn för komponenten som rapporterar statusmeddelandet. Det här namnet kan inte lokaliseras till andra språk eftersom Configuration Manager-administratören skapar frågor och filterregler som baseras på komponentnamnet. Detta hjälper administratören att snabbt hämta dina specifika statusmeddelanden och konfigurera Configuration Manager för att hantera dessa statusmeddelanden på särskilda sätt.

I parametern pszSiteCode anger du koden för den Configuration Manager plats som meddelandet ska skickas till. Koden måste vara för en av de platser som Configuration Manager-klienten för närvarande tillhör. I allmänhet bör du ange null för den här parametern för att ange att statusmeddelandet ska rapporteras till alla Configuration Manager platser som Configuration Manager-klienten tillhör.

Statussystemet stoppar replikeringen på den plats som anges av pszTopLevelSiteCode oavsett hur administratören har konfigurerat replikeringsreglerna. I allmänhet bör du ange null för den här parametern för att indikera att det inte finns någon platskod på den översta nivån och att meddelandet kan replikeras hela vägen till toppen av hierarkin. Men om det finns en anledning att förhindra replikeringen förbi en viss plats kan du ange platskoden för platsen med hjälp av parametern pszTopLevelSiteCode .

Krav

Smscstat.dll.

Körningskrav

Mer information finns i Configuration Manager Krav för klientkörning.

Utvecklingskrav

Mer information finns i Configuration Manager Krav för klientutveckling.

Se även

SMSCSTAT.DLL statusmeddelandefunktioner