Ets_Obj_Type_Namespace_Get()
Abstract
Gets a string representing the namespace used by an object.
Syntax
Ets_Obj_Type_Namespace_Get (obj_type, namespace_str, buf_len_ptr)
| Argument | Type | Description |
|---|---|---|
obj_type |
EtsT_Obj_Type |
Object of interest. |
namespace_str |
char * |
Buffer to hold the namespace string. |
buf_len_ptr |
int * |
Length of the namespace_str buffer (see Details). |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the namespace string is obtained; EtsC_Compcode_Failure otherwise.
Header
ets_api_obj.h
Details
Every object exists in a namespace, each member of which must have a unique name. For example, node objects (fixed, mobile, and satellite) exist in the "Node" namespace and link objects (both simplex and duplex) exist in the "Link" namespace.
This function writes a string representing the object's namespace to namespace_str. If the buffer is not long enough to hold the string, EtsC_Compcode_Failure is returned and buf_len_ptr is set to the minimum buffer length required to hold the namespace string (that is, string length + 1). If no namespace exists, EtsC_Compcode_Failure is returned and buf_len_ptr is set to 0.