man pages section 3: Extended Library Functions, Volume 2

IMA_SetNodeAlias (3IMA)

Name

IMA_SetNodeAlias - Sets the alias of a specified node

Synopsis

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

IMA_STATUS IMA_SetNodeAlias
      /* in */      IMA_OID nodeOid,
      /* in */      const IMA_NODE_ALIAS newAlias
);

Parameters

nodeOid

The object ID of the node whose alias is being set.

newAlias

A pointer to the Unicode string that contains the new node alias. If this parameter is NULL, then the current alias is deleted, and the specified node no longer has an alias.

Description

The IMA_SetNodeAlias() API sets the alias of a specified node.

Return Values

IMA_STATUS_REBOOT_NECESSARY

Returned if a reboot is necessary before the setting of the alias takes effect

IMA_ERROR_INVALID_PARAMETER

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

IMA_ERROR_INVALID_OBJECT_TYPE

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

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the nodeOid argument does not specify a node object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the nodeOid argument does not specify a node known to the system

IMA_ERROR_NAME_TOO_LONG

Returned if the newAlias argument contains more than 255 bytes when encoded in the UTF-8 format

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_GetSharedNodeOid(3IMA), IMA_GetNodeProperties(3IMA), IMA_SetNodeName(3IMA)