HBA_RegisterForAdapterPortEvents routine

The HBA_RegisterForAdapterPortEvents routine registers the indicated user callback routine to call when a port event occurs.

Syntax

HBA_STATUS HBA_API HBA_RegisterForAdapterPortEvents(
   HBA_PORT_CALLBACK  callback,
   void               *userData,
   HBA_HANDLE         handle,
   HBA_WWN            PortWWN,
   HBA_CALLBACKHANDLE *callbackHandle
);

Parameters

  • callback
    Pointer to a callback routine of type HBA_PORT_CALLBACK that is called when an adapter is added to the system.

  • userData
    Pointer to a buffer that is passed to the callback routine with each event. This data correlates the event with the source of the event registration.

  • handle
    Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA for which the adapter events are generated.

  • PortWWN
    Contains a 64-bit worldwide name (WWN) that uniquely identifies the HBA port from which port events are reported. For a discussion of worldwide names, see the T11 committee's Fibre Channel HBA API specification.

  • callbackHandle
    Contains an opaque identifier that the user must pass to HBA_RemoveCallback to de-register the callback routine.

Return value

The HBA_RegisterForAdapterPortEvents routine returns a value of type HBA_STATUS that indicates the status of the HBA. In particular, this member should have one of the following values.

Return code Description
HBA_STATUS_OK

Returned if the callback routine was successfully registered.

HBA_STATUS_ERROR_ILLEGAL_WWN

Returned if the HBA referenced by handle does not have a port with a name that matches the value in PortWWN.

HBA_STATUS_ERROR

Returned if an unspecified error occurred that prevented the registration of the callback routine.

 

Remarks

For a list of port events, see HBA_PORT_CALLBACK.

Requirements

Target platform

Desktop

Header

Hbaapi.h (include Hbaapi.h)

Library

Hbaapi.lib

DLL

Hbaapi.dll

See also

HBA_OpenAdapter

HBA_PORT_CALLBACK

HBA_RemoveCallback

HBA_STATUS

 

 

Send comments about this topic to Microsoft