Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_IsPhbaDownloadFile (3IMA)

Name

IMA_IsPhbaDownloadFile - Determines if a file is suitable for download to a PHBA

Synopsis

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

IMA_STATUS IMA_IsPhbaDownloadFile(
     /* in */     IMA_OID phbaOid,
     /* in */     const IMA_WCHAR *pFileName,
     /* out */    IMA_PHBA_DOWNLOAD_IMAGE_PROPERTIES *pProps
);

Parameters

phbaOid

The object ID of the PHBA (physical host bus adapter) whose download properties are queried.

pFileName

A pointer to the name, and if necessary the path, of a file that is to be examined to determine if it contains a downloadable image for the specified PHBA.

pProps

A pointer to an IMA_PHBA_DOWNLOAD_IMAGE_PROPERTIES data structure allocated by the caller. If returned successfully, this data structure contains the properties of the specified image file.

Description

The IMA_IsPhbaDownloadFile() API determines if a file is suitable for download to a PHBA.

Return Values

IMA_ERROR_NOT_SUPPORTED

Returned if this API is not supported by the specified PHBA

IMA_ERROR_INVALID_PARAMETER
  • Returned if the pFileName argument is NULL, or specifies a memory area from which data cannot be read

  • Returned if the pFileName argument specifies a file that cannot be opened for reading or does not contain a download image that can be download to the specified PHBA

  • Returned if the pProps argument is NULL, or specifies a memory to which data cannot 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_GetPhbaDownloadProperties(3IMA), IMA_PhbaDownload(3IMA)