WHEAErrorSourceMethods::SetErrorSourceInfoRtn method

Deprecated. Do not use. The WHEAErrorSourceMethods::SetErrorSourceInfoRtn WMI provider method sets the error source information for a particular error source that is supported by the hardware platform.

Syntax


void SetErrorSourceInfoRtn(
  [out, retval] uint32 *Status,
  [in]          uint32 Length,
  [in]          uint8  ErrorSourceInfo[]
);

Parameters

Status [out, retval]

The result of the call to the WHEAErrorSourceMethods::SetErrorSourceInfoRtn method. The value that is returned is an NTSTATUS code.

Length [in]

[in] The size, in bytes, of the buffer that is provided in the ErrorSourceInfo parameter.

ErrorSourceInfo[] [in]

[in] A buffer that contains a WHEA_ERROR_SOURCE_DESCRIPTOR structure.

Return value

None

Remarks

A user-mode WHEA management application calls the WHEAErrorSourceMethods::SetErrorSourceInfoRtn method to set the error source information for a particular error source that is supported by the hardware platform.

An application can modify the configuration of an error source by performing the following steps:

  1. Retrieve the WHEA_ERROR_SOURCE_DESCRIPTOR structure that describes the particular error source.

    A user-mode WHEA management application can retrieve a list of WHEA_ERROR_SOURCE_DESCRIPTOR structures that describe all of the error sources that are supported by the hardware platform by calling the WHEAErrorSourceMethods::GetAllErrorSourcesRtn method. Alternatively, such an application can retrieve a WHEA_ERROR_SOURCE_DESCRIPTOR structure that describes an individual error source that is supported by the hardware platform by calling the WHEAErrorSourceMethods::GetErrorSourceInfoRtn method.

  2. Modify the contents of the WHEA_ERROR_SOURCE_DESCRIPTOR structure to change the configuration of the error source.

  3. Set the error source information for the error source by calling the WHEAErrorSourceMethods::SetErrorSourceInfoRtn method.

A user-mode WHEA management application does not call the WHEAErrorSourceMethods::SetErrorSourceInfoRtn method directly. It must call it indirectly by calling the IWbemServices::ExecMethod method. For more information about how to call methods in WMI provider classes, see the Calling a Provider Method topic in the Microsoft Windows SDK documentation.

Changes that are made to the configuration of an error source will not become effective until the system is restarted. Therefore, after a WHEA management application calls the WHEAErrorSourceMethods::SetErrorSourceInfoRtn method to configure one or more error sources, it should notify the user that the system must be restarted in order for the configuration changes to take effect.

Requirements

Target platform

Version

Supported in Windows Server 2008, Windows Vista SP1, and later versions of Windows.

See also

WHEAErrorSourceMethods::GetAllErrorSourcesRtn
WHEAErrorSourceMethods::GetErrorSourceInfoRtn
WHEA_ERROR_SOURCE_DESCRIPTOR

 

 

Send comments about this topic to Microsoft

Show: