man pages section 3: Extended Library Functions, Volume 2

IMA_GetIpProperties (3IMA)

Name

IMA_GetIpProperties - Gets the IP properties of the specified PNP

Synopsis

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

IMA_STATUS IMA_GetIpProperties(
 /* in */     IMA_OID oid,
 /* out */    IMA_IP_PROPERTIES *pProps
);

Parameters

oid

The object ID of the physical network port (PNP) whose IP properties are to be retrieved.

pProps

A pointer to an IMA_IP_PROPERTIES data structure. When returned successfully, this argument contains the IP properties of the PNP specified by the oid argument.

Description

The IMA_GetIpProperties() API gets the IP properties of the specified PNP.

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 a PNP object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify a PNP 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_SetDefaultGateway(3IMA), IMA_SetDnsServerAddress(3IMA), IMA_SetIpConfigMethod(3IMA), IMA_SetSubnetMask(3IMA)