Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_GetInUseInitiatorAuthMethods (3IMA)

Name

IMA_GetInUseInitiatorAuthMethods - Gets the authentication methods being used by the specified LHBA

Synopsis

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

IMA_STATUS IMA_GetInUseInitiatorAuthMethods(
 /* in */      IMA_OID      lhbaOid,
 /* in, out */ IMA_UINT *pMethodCount,
 /* out */     IMA_AUTHMETHOD *pMethodList;
);

Parameters

lhbaOid

The object ID of a logical host bus adapter (LHBA) whose authentication methods are to be retrieved.

pMethodCount

A pointer to an IMA_UINT data structure allocated by the caller.

On entry, the value this argument points to is the maximum number of entries that can be placed into the pMethodList argument.

When the argument is returned, the value this argument points to is the number of entries that were actually placed into the pMethodList argument.

pMethodList

Either a pointer to an array of IMA_AUTHMETHOD dta structures allocated by the caller, or NULL.

If this argument is not NULL, when it is returned successfully, the array will be filled with the authentication methods being used by the LHBA, in decreasing order of preference for use by the LHBA.

If this argument is NULL, then the value pointed to by the pMethodCount argument on entry is zero.

Description

The IMA_GetInUseInitiatorAuthMethods() API gets the authentication methods being used by the specified LHBA.

Return Values

IMA_ERROR_INVALID_PARAMETER

Returned if the pMethodList argument specifies a memory area to which data cannot be written

IMA_ERROR_INVALID_OBJECT_TYPE

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

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the lhbaOid argument does not specify an LHBA

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the lhbaOid argument does not specify an LHBA 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_GetSupportedAuthMethods(3IMA), IMA_SetInitiatorAuthMethods(3IMA)