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

Parameters

hStatusMessageObject

Data type: HANDLEQualifiers: [in, out]Handle to the status message object. On input, supply the handle retrieved by CreateSMSStatusMessage Function. On successful return from the function, this parameter contains the handle to the deallocated object.The behavior of this function is undefined for invalid handles and throws an access violation exception. Therefore, ensure that you supply a valid handle for this parameter. See Remarks.

pszComponentName

Data type: LPCSTRQualifiers: [in]Pointer to the name of the component reporting the status message. This name is a null-terminated ASCII component name. It appears in Status Message Viewer in the Component column and in Windows NT Event Viewer in the Category column. For more information , see the Remarks section later in this topic.

pszSiteCode

Data type: LPCSTRQualifiers: [in]Pointer to the Configuration Manager site code for the site to which to report the status message. The code is a null-terminated ASCII code that is exactly three characters long. Alternatively you can set this parameter to null. For more information, see the Remarks section later in this topic.

pszTopLevelSiteCode

Data type: LPCSTRQualifiers: [in]Pointer to the Configuration Manager site code for the highest site in the hierarchy to which the message can be replicated. The code is a null-terminated ASCII code. Alternatively, you can set this parameter to null. For more information, see the Remarks section later in this topic.

This function returns one of the values in the following table.

Smscstat.h includes the following #define for calling ReportSMSStatusMessage by using the Win32 function GetProcAddress.

	Copy Code
#define PROCNAME_REPORTSMSSTATUSMESSAGE "ReportSMSStatusMessage"

When calling this function, use the hStatusMessageObject parameter to supply a handle for the status message to report. When this function returns, the retrieved object is guaranteed to be deallocated, regardless of the success of the function. If the function is unsuccessful and you want your application to try again, create a new status message before calling ReportSMSStatusMessage.

Use the pszComponentName parameter of this function to supply a name for the component that is reporting the status message. This name is not localizable to other languages, because the Configuration Manager administrator creates queries and filter rules that are based on the component name. This assists the administrator in quickly retrieving your particular status messages and in configuring Configuration Manager to handle these status messages in special ways.

In the pszSiteCode parameter, supply the code for the Configuration Manager site to which to submit the message. The code must be for one of the sites to which the Configuration Manager client currently belongs. Generally, you should supply null for this parameter, to indicate that the status message should be reported to all Configuration Manager sites to which the Configuration Manager client belongs.

The status system stops replication at the site indicated by pszTopLevelSiteCode no matter how the administrator has configured the replication rules. Generally, you should specify null for this parameter, to indicate that there is no top-level site code and that the message is free to replicate all the way to the top of the hierarchy. However, if there is a reason to prevent the replication past a certain site, you can supply the site code of that site using the pszTopLevelSiteCode parameter.

Smscstat.dll.

Runtime Requirements

Development Requirements

Other Resources