This topic has not yet been rated - Rate this topic

HBA_SendCTPassThru routine

The HBA_SendCTPassThru routine sends a common transport (CT) pass-through command.

Syntax


HBA_STATUS HBA_API HBA_SendCTPassThru(
  _In_   HBA_HANDLE HbaHandle,
  _In_   void *pReqBuffer,
  _In_   HBA_UINT32 ReqBufferSize,
  _Out_  void *pRspBuffer,
  _In_   HBA_UINT32 RspBufferSize
);

Parameters

HbaHandle [in]: Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA that will route the CT command. The HBA routes the CT command to the server that runs the service requested by the CT command.
pReqBuffer [in]: Pointer to a buffer that contains the full frame of the common transport command in big-endian (wire) format.
ReqBufferSize [in]: Indicates the size of the buffer pointed to by pReqBuffer:
pRspBuffer [out]: Pointer to a buffer that contains the payload data from the reply to the common transport command in big-endian (wire) format.
RspBufferSize [in]: Indicates the size of the buffer pointed to by pRspBuffer.

Return value

The HBA_SendCTPassThru routine returns a value of type HBA_STATUS that indicates the status of the HBA. If the HBA successfully delivers the command to the destination service, and the service executes the command and successfully returns the results, the HBA_SendCTPassThru routine returns a value of HBA_STATUS_OK. If the command does not succeed, this routine returns an appropriate error code of type HBA_STATUS.

Remarks

The HBA_SendCTPassThru library routine serves a purpose very similar to the SendCTPassThru WMI method.

A CT command can request services that distribute encryption keys, IP addresses, time stamps, names, aliases, fabric configuration, and security policies. For a complete list of the service types that can be specified in a CT command, see the Fibre Channel Generic Services - 4 (FC-GS-4) specification published by the ANSI committee.

Requirements