Man page - smi_identity(3)

Packages contains this manual

Package: libsmi2-dev
apt-get install libsmi2-dev

Manuals in package:

Documentations in package:

libsmi2-dev

Manual

smi_identity

NAME
SYNOPSIS
DESCRIPTION
FILES
SEE ALSO
AUTHOR

NAME

smiGetIdentity, smiGetFirstIdentity, smiGetNextIdentity, smiGetParentIdentity, smiGetIdentityModule - SMI identity information routines

SYNOPSIS

#include <smi.h>

SmiIdentity *smiGetIdentity(SmiModule * smiModulePtr , char * name);

SmiIdentity *smiGetFirstIdentity(SmiModule * smiModulePtr );

SmiIdentity *smiGetNextIdentity(SmiIdentity * smiIdentityPtr );

SmiIdentity *smiGetParentIdentity(SmiIdentity * smiIdentityPtr );

SmiModule *smiGetIdentityModule(SmiType * smiIdentityPtr );

typedef struct SmiIdentity {
SmiIdentifier name;
SmiDecl decl;
SmiStatus status;
char *description;
char *reference;
} SmiIdentity;

DESCRIPTION

These functions retrieve information on a SMIng identity definition (SMIng).

smiGetIdentity(SmiModule *smiModulePtr,char *name) returns a pointer to struct SmiIdentity for the identity with the given name in the given module( smiModulePtr ), or NULL if the idenity with the given name does not exist

smiGetFirstIdentity(SmiModule *smiModulePtr) and smiGetNextIdentity(SmiIdentity *smiIdentityPtr) are used to iterate through the identities of the module given by smiModulePtr . They return a pointer to struct SmiIdentity hat represents an identity or NULL if there are no identities left in the module, or error has occurred.

smiGetIdentityModule(SmiIdentity *smiIdentityPtr) returns a pointer to struct SmiModule , of the module containing the given identity.

smiGetParentIdentity(SmiIdentity *smiIdentityPtr) returns a pointer to struct SmiIdentity pointing to the parent of the given smiIdentityPtr , or NULL if the Identity is not derived.

FILES

${prefix}/include/smi.h SMI library header file