HBA_GetFcpTargetMapping routine
The HBA_GetFcpTargetMapping routine retrieves the mappings between operating system and fibre channel protocol (FCP) identifiers for a set of targets that the HBA can enumerate.
Syntax
HBA_STATUS HBA_API HBA_GetFcpTargetMapping(
_In_ HBA_HANDLE HbaHandle,
_Inout_ PHBA_FCPTARGETMAPPING Mapping
);
Parameters
HbaHandle [in]
Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA to query for the target mappings. The HBA returns mappings for the targets that it can enumerate.Mapping [in, out]
Pointer to a structure of type HBA_FCPTargetMapping that contains an array of bindings between operating system and FCP identifiers for a set of target devices. These mappings are maintained by the HBA referenced by HbaHandle. On input, the NumberOfEntries member of HBA_FCPTargetMapping should contain a number of mappings that fit in the output buffer. On output, the NumberOfEntries contains the number of mappings requested, or the full set of mappings, whichever is smaller. The value in NumberOfEntries contains the number of mappings returned even when an error occurred due to insufficient buffer space.
Return value
The HBA_GetFcpTargetMapping routine returns a value of type HBA_STATUS that indicates the status of the HBA. In particular, HBA_GetFcpTargetMapping returns one of the following qualifiers.
| Return code | Description |
|---|---|
| HBA_STATUS_OK | Returned if all the mapping entries were retrieved. |
| HBA_STATUS_ERROR_MORE_DATA | Returned if there was insufficient buffer space to retrieve all of the target mappings. |
| HBA_STATUS_ERROR | Returned if an unspecified error occurred that prevented the retrieval of the target mappings. |
Requirements
Target platform |
Desktop |
Header |
Hbaapi.h (include Hbaapi.h) |
Library |
Hbaapi.lib |
DLL |
Hbaapi.dll |
See also