Retrieving ProGroup Name

[barbers73]

I am attempting to retrieve group names for each group in the ProSolid. I can retrieve the groups using ProSolidGroupCollect(), but the ProGroup class does not include access to the group's name. The parent class Pro_Model_Item has a function ProModelitemNameGet() but, according to the documentation, Pro_Group is an invalid type and will return an error code. Is anyone aware of an alternative method to get the name of a Group?

Sharon

 

[williaps]

barbers73,


Read the API Wizard under User's Guide->Basic Access to Features->Read Access to Groups->Group Information. Use the function ProUdfNameGet to retrieve the name of the group.


The function ProUdfNameGet()[/b] returns the name of the group. For a local group, this is the name assigned upon creation. For a UDF-created group, this is the name of the UDF file. If the UDF is an instance in a UDF family table, the function also returns the instance name.
Function ProUdfNameGet







Description


Give the name of the UDF which was used to place the specified group.

Synopsis

#include <ProUdf.h>

ProError
ProUdfNameGet
(


ProGroup *udf



/* (In)


The UDF.


*/


ProName name



/* (Out)


The name of the UDF


*/


ProName instance



/* (Out)


The name of the instance in the UDF family table of which this is an instance. An empty string if the UDF is the generic, or has no family table.


*/

)

Returns






PRO_TK_NO_ERROR

The function succeeded.

PRO_TK_BAD_INPUTS

One or more input arguments was invalid.

PRO_TK_GENERAL_ERROR

The group is not a UDF