Renames the study that has the specified ID.
.NET Syntax
Visual Basic (Declaration) | |
---|
Function RenameStudyFromID( _
ByVal NIndex As System.Integer, _
ByVal SName As System.String _
) As System.Integer |
Visual Basic (Usage) | |
---|
Dim instance As ICWStudyManager
Dim NIndex As System.Integer
Dim SName As System.String
Dim value As System.Integer
value = instance.RenameStudyFromID(NIndex, SName) |
C# | |
---|
System.int RenameStudyFromID(
System.int NIndex,
System.string SName
) |
C++/CLI | |
---|
System.int RenameStudyFromID(
& System.int NIndex,
& System.String^ SName
) |
Parameters
- NIndex
- ID of study to rename
- SName
- New name of study
Return Value
Error as defined by
swsStudyError_e
See Also
Availability
SOLIDWORKS Simulation API 2014 SP0