SendRLS function

Article
12/15/2021

The SendRLS WMI method sends a read link error status block (RLS) through the indicated local port to the indicated remote port to retrieve a link error status block associated with the remote port.

Syntax

void SendRLS(
   [out, HBA_STATUS_QUALIFIERS] HBA_STATUS       HBAStatus,
   [in, HBAType("HBA_WWN")] uint8                PortWWN[8],
   [in, HBAType("HBA_WWN")] uint8                DestWWN[8],
   [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 SendRLS_OUT structure.

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

DestWWN
A worldwide name for the destination port. This information is delivered to the miniport driver in the DestWWN member of a SendRLS_IN structure.

TotalRspBufferSize
The size in bytes of the results of the RLS command. The miniport driver returns this information in the TotalRspBufferSize member of a SendRLS_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 SendRLS_OUT structure.

RspBuffer
The results of the RLS command. The miniport driver returns this information in the RspBuffer member of a SendRLS_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