man pages section 3: Extended Library Functions, Volume 2

IMA_GetDefaultTime2WaitProperties (3IMA)

Name

IMA_GetDefaultTime2WaitProperties - Gets the DefaultTime2Wait iSCSI login parameter properties

Synopsis

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

IMA_STATUS IMA_GetDefaultTime2WaitProperties(
 /* in */     IMA_OID oid,
 /* out */    IMA_MIN_MAX_VALUE *pProps
);

Parameters

oid

The object ID of the logical host bus adapter (LHBA) or target whose DefaultTime2Wait properties are to be retrieved.

pProps

A pointer to an IMA_MIN_MAX_VALUE data structure allocated by the caller. If successfully returned, this structure contains the DefaultTime2Wait properties for the specified LHBA or target.

Description

The IMA_GetDefaultTime2WaitProperties() API gets the DefaultTime2Wait iSCSI login parameter properties for the specified LHBA or target.

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 oid argument does not specify a valid object type

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the oid argument does not specify an LHBA or target object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify an LHBA or target 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_SetDefaultTime2Wait(3IMA)