pe_adjhcs_status

Returns the status of an object

Usage syntax

unsigned char pe_adjhcs_status (PE_ADJHCS *p);

Parameters

p

The pointer to an object

Description

This function returns the status of an adjusted horizontal coordinate system object.

Returns

The possible status values returned are as follows:

   PE_STATUS_NONE         0x00  /* Not set                                    */
   PE_STATUS_NEW          0x01  /* Created via pe_*_new() function            */
   PE_STATUS_STRING       0x02  /* Created via pe_*_from_string() function    */
   PE_STATUS_CODE         0x04  /* Created via pe_factory_*() function        */
   PE_STATUS_USER         0x08  /* Created via PEOBJEDITHOME                  */
   PE_STATUS_DEPRECATED   0x10  /* Deprecated (invalid) factory code          */
   PE_STATUS_DISCONTINUED 0x20  /* Discontinued (no replacement) factory code */
Examples

status = pe_adjhcs_status(adjcs);