HBA_SendReadCapacity routine

The HBA_SendReadCapacity routine sends a SCSI read capacity command to the indicated remote port.

Syntax

HBA_STATUS HBA_API HBA_SendReadCapacity(
  _In_  HBA_HANDLE handle,
  _In_  HBA_WWN    portWWN,
  _In_  HBA_UINT64 fcLUN,
  _Out_ void       *pRspBuffer,
  _In_  HBA_UINT32 RspBufferSize,
  _Out_ void       *pSenseBuffer,
  _In_  HBA_UINT32 SenseBufferSize
);

Parameters

  • handle [in]
    Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA through which the SCSI read capacity command is sent.

  • portWWN [in]
    Contains a 64-bit worldwide name (WWN) that uniquely identifies the remote target port to which the SCSI read capacity command is sent. For a discussion of worldwide names, see the T11 committee's Fibre Channel HBA API specification.

  • fcLUN [in]
    Indicates the fibre channel logical unit number of the logical unit to which the SCSI read capacity command will be sent.

  • pRspBuffer [out]
    Pointer to a buffer that receives the output data of the SCSI read capacity command.

  • RspBufferSize [in]
    Indicates the size, in bytes, of the buffer at pRspBuffer.

  • pSenseBuffer [out]
    Pointer to a buffer that receives the SCSI sense data.

  • SenseBufferSize [in]
    On input, indicates on input the size, in bytes, of the buffer at pSenseBuffer. On output, this member indicates the number of bytes of sense data returned.

Return value

The HBA_ScsiReadCapacity routine returns a value of type HBA_STATUS that indicates the status of the HBA. In particular, HBA_ScsiReadCapacity returns one of the following values.

Return code Description
HBA_STATUS_OK

Returned if the complete payload of a reply to the SCSI read capacity command was successfully retrieved.

HBA_STATUS_ERROR_ILLEGAL_WWN

Returned if the HBA referenced by handle does not contain a port with a name that matches HbaPortWWN.

HBA_STATUS_ERROR_NOT_A_TARGET

Returned if the specified remote port specified by portWWN does not have SCSI target functionality.

HBA_STATUS_ERROR_TARGET_BUSY

Returned if the SCSI read capacity command could not be delivered without causing a SCSI overlapped command condition.

HBA_STATUS_SCSI_CHECK_CONDITION

Returned if a SCSI check condition occurred and SCSI send data is provided in the buffer at pSenseBuffer.

HBA_STATUS_ERROR

Returned if an unspecified error occurred that prevented the execution of the SCSI inquiry command.

 

Requirements

Target platform

Desktop

Header

Hbaapi.h (include Hbaapi.h)

Library

Hbaapi.lib

DLL

Hbaapi.dll

See also

HBA_OpenAdapter

HBA_STATUS

 

 

Send comments about this topic to Microsoft