oms_aa_address_handle_get()
Abstract
Returns an address handle to be used for assigning addresses of a specific type.
Syntax
oms_aa_address_handle_get (address_category, attribute_name)
| Argument | Type | Description |
|---|---|---|
address_category |
string |
Type of address being registered (e.g., “MAC Addresses”) [Must be 128 characters or less] |
attribute_name |
string |
name of address attribute (e.g., “MAC Address”) [Must be 128 characters or less] |
Return Type
OmsT_Aa_Address_Handle
Handle to the address list indicated by address_category and attribute_name
Details
Before it can register an address, an object must obtain a handle for the corresponding address list. This procedure returns a handle for the address list indicated by the address_category and attribute_name arguments. If the address list does not exist, this procedure creates a new list and returns its handle.
Example
From eth_mac_v2 process model, function block, ethernet_mac_sv_init() function:
/* Obtain the node's object identifier. */
own_node_objid = op_topo_parent (my_objid);
/* Obtain the process's process handle. */
own_prohandle = op_pro_self ();
/* Obtain the address handle assigned to this node. The string */
/* "MAC Addresses" rendezvous with other MACs to guarantee */
/* unique addresses across all MAC types. The OMS_AA package */
/* handles this feature. */
oms_aa_handle = oms_aa_address_handle_get ("MAC Addresses", "station_address");