Download C3Dserver User Guide - Motion Lab Systems, Inc.
Transcript
Set group name This sets the name for the specified group. HRESULT SetGroupName (int nIndex, BSTR sName, int *pReturn) Return Value A standard HRESULT value. Parameters nIndex - [in] This is the index of the group. This is a zero based number and thus must be in the range 0 to (GetNumberGroups-1). sName - [in] This is the new name for the group. This name should not belong to any other group. pReturn - [out] 1 if the change was made, 0 if it was not made. Remarks By default the C3Dserver will check that the first six characters of a new group name are unique unless StrictParameterChecking has been disabled. Attempts to rename a group to a name that contain the same six first six characters as an existing group will fail unless StrictParameterChecking has been disabled. Possible Error Values 2015 – If the data in the file was not read in the first place. 2011 – An invalid index used. 2020 – The group name is empty. 2022 – The group name already exists. Example nIndex = itf.GetGroupIndex(“ANALOG”) nSuccess = itf.SetGroupName(nIndex, “ANALOG1”) This set of function calls will modify the name of the ANALOG group to ANALOG1. 56 • C3D Group functions User Reference Manual C3Dserver