SendRPS function

Article
12/15/2021

The SendRPS WMI method sends a read port status block (RPS) request to the indicated port or domain controller.

Syntax

void SendRPS(
   [out, HBA_STATUS_QUALIFIERS] HBA_STATUS       HBAStatus,
   [in, HBAType("HBA_WWN")] uint8                PortWWN[8],
   [in, HBAType("HBA_WWN")] uint8                AgentWWN[8],
   [in, HBAType("HBA_WWN")] uint8                ObjectWWN[8],
   [in] uint32                                   AgentDomain,
   [in] uint32                                   ObjectPortNumber,
   [out] uint32                                  TotalRspBufferSize,
   [out] uint32                                  ActualRspBufferSize,
   [out, WmiSizeIs("ActualRspBufferSize")] uint8 RspBuffer[]
);

Parameters

HBAStatus
On return, contains the status of the operation. For a list of allowed values and their descriptions, see HBA_STATUS. The miniport driver returns this information in the HBAStatus member of a SendRPS_OUT structure.

PortWWN
A worldwide name for the local port through which the RPS command is sent. This information is delivered to the miniport driver in the PortWWN member of a SendRPS_IN structure.

AgentWWN
A worldwide name for the port that is to be queried for the status of the port indicated by ObjectWWN. This information is delivered to the miniport driver in the AgentWWN member of a SendRPS_IN structure.

ObjectWWN
The worldwide name of the port for which port status is to be returned. This information is delivered to the miniport driver in the ObjectWWN member of a SendRPS_IN structure.

AgentDomain
The domain number of the domain controller to be queried for the status of the port indicated by ObjectWWN. This information is delivered to the miniport driver in the AgentDomain member of a SendRPS_IN structure.

ObjectPortNumber
The worldwide name of the port for which port status is to be returned. This information is delivered to the miniport driver in the ObjectPortNumber member of a SendRPS_IN structure.

TotalRspBufferSize
The size in bytes of the results of the RPS command. The miniport driver returns this information in the TotalRspBufferSize member of a SendRPS_OUT structure.

ActualRspBufferSize
The size in bytes of the data that was actually retrieved. The miniport driver returns this information in the ActualRspBufferSize member of a SendRPS_OUT structure.

RspBuffer
The results of the RPS command. The miniport driver returns this information in the RspBuffer member of a SendRPS_OUT structure.

Return value

Not applicable to WMI methods.

Remarks

This WMI method belongs to the MSFC_HBAAdapterMethods WMI Class.

Requirements

Target platform	Desktop
Header	Hbapiwmi.h (include Hbapiwmi.h, Hbaapi.h, or Hbaapi.h)
Library	Hbaapi.lib