sess_get_obj_create_info
sess_get_obj_create_info(sesshdl, asisstart, asisend, top, return_array)
For the session sesshdl, this function builds an array return_array containing the default creation information for a new object. The return_array is an associative array and can be used to build a user interface that shows default values for a new object and allows the user to override those defaults.
The asisstart and asisend parameters define the starting and ending nodes for the new object.
The top parameter indicates whether the “topmost is filename” naming rule is being used.
The array is the same for all adapters. Some adapters do not use all the indices in the array; these indices will be left empty.
The ACL array return_array will contain the following data:
|
Array index
|
Value description
|
|
IO_CRE_NAME
|
Default name for the new object, according to the default naming rules.
|
|
IO_CRE_LOCATION
|
Default location for the new object.
|
|
IO_CRE_OBJECT_TYPE
|
Default object type for the new object.
|
|
IO_CRE_LABEL
|
Default version label for the new object.
|
If sesshdl is invalid, or the operation fails, the function writes error data to $main::ioerr and returns a zero (0). If the operation is successful, the function returns a one (1).