Edit

SendRPL function

  • Article

The SendRPL WMI method sends a read port list (RPL) command through the indicated port to indicated destination port.

Syntax

void SendRPL(
   [out, HBA_STATUS_QUALIFIERS] HBA_STATUS       HBAStatus,
   [in, HBAType("HBA_WWN")] uint8                PortWWN[8],
   [in, HBAType("HBA_WWN")] uint8                AgentWWN[8],
   [in] uint32                                   agent_domain,
   [in] uint32                                   portIndex,
   [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 SendRPL_OUT structure.

PortWWN
A worldwide name for the local port through which the read port list (RPL) command is sent. This information is delivered to the miniport driver in the PortWWN member of a SendRPL_IN structure.

AgentWWN
A worldwide name for the port that is to be queried for a list of ports of type FC_Port. For a definition of FC_Port, see the T11 committee's Fibre Channel HBA API specification. This information is delivered to the miniport driver in the AgentWWN member of a SendRPL_IN structure.

agent_domain
The domain number for the domain controller that is to be queried for a list of ports of type FC_Port. For a definition of FC_Port, see the T11 committee's Fibre Channel HBA API specification. This information is delivered to the miniport driver in the agent_domain member of a SendRPL_IN structure.

portIndex
The port index of the first port in the list of ports of type FC_Port to be returned. This information is delivered to the miniport driver in the portIndex member of a SendRPL_IN structure.

TotalRspBufferSize
The size in bytes of the results of the read port list (RPL) command. The miniport driver returns this information in the TotalRspBufferSize member of a SendRPL_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 SendRPL_OUT structure.

RspBuffer
The results of the read port list (RPL) command. The miniport driver returns this information in the RspBuffer member of a SendRPL_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

See also

HBA_STATUS

SendRPL_IN

SendRPL_OUT