man pages section 3: Extended Library Functions, Volume 2

IMA_GetPhbaDownloadProperties (3IMA)

Name

IMA_GetPhbaDownloadProperties - Gets the download properties for the specified physical host bus adapter (PHBA)

Synopsis

cc [ flag... ] file... -lima [ library... ]
#include <ima.h>

IMA_STATUS IMA_GetPhbaDownloadProperties(
 /* in */     IMA_OID phbaOid,
 /* out */    IMA_PHBA_DOWNLOAD_PROPERTIES *pProps
);

Parameters

phbaOid

The object ID of the PHBA whose download properties are being queried.

pProps

A pointer to an IMA_PHBA_DOWNLOAD_PROPERTIES data structure allocated by the caller. If returned successfully, this data structure contains the download properties of the specified PHBA.

Description

The IMA_GetPhbaDownloadProperties() API gets the download properties for the specified PHBA.

Return Values

IMA_ERROR_INVALID_PARAMETER

Returned if the pProps argument is NULL, or specifies a memory area to which data cannot be written

IMA_ERROR_INVALID_OBJECT_TYPE

Returned if the phbaOid argument does not specify a valid object type

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the phbaOid argument does not specify a PHBA object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the phbaOid argument does not specify a PHBA known to the system

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE Availability system/library/storage/snia-ima Interface Stability Volatile MT-Level Safe

See Also

libima(3LIB), attributes(7), IMA_GetPhbaOidList(3IMA), IMA_IsPhbaDownloadFile(3IMA), IMA_PhbaDownload(3IMA)