Sets up a structure of type 'body' - defining a celestial object- based on the input parameters.

Namespace: ASCOM.Astrometry.NOVAS
Assembly: ASCOM.Astrometry (in ASCOM.Astrometry.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
public short SetBody(
	BodyType type,
	Body number,
	string name,
	ref BodyDescription cel_obj
)
Visual Basic
Public Function SetBody ( _
	type As BodyType, _
	number As Body, _
	name As String, _
	ByRef cel_obj As BodyDescription _
) As Short
Visual C++
public:
virtual short SetBody(
	BodyType type, 
	Body number, 
	String^ name, 
	BodyDescription% cel_obj
) sealed

Parameters

type
Type: ASCOM.Astrometry..::..BodyType
Type of body
number
Type: ASCOM.Astrometry..::..Body
Body number
name
Type: System..::..String
Name of the body.
cel_obj
Type: ASCOM.Astrometry..::..BodyDescription%
OUT: Structure containg the body definition

Return Value

 = 0 ... everything OK
 = 1 ... invalid value of 'type'
 = 2 ... 'number' out of range

Remarks