NCL Website header
NCL Home > Documentation > HLUs > API

NhlAppGetDefaultParentId

The Fortran name of this function is NhlFAppGetDefaultParentId.

This function retrieves the Id of the current default parent App object.


C Synopsis

#include <ncarg/hlu/App.h>

int NhlAppGetDefaultParentId(
		void
		)

Fortran Synopsis

      subroutine NhlFAppGetDefaultParentId(id)
      integer id

Arguments

id (output, Fortran only)
On output contains the id of the current default App object.

Description

This function returns the Id of the App object that will currently be used as the parent of any objects that are created with the constant NhlDEFAULT_APP or 0 as the parentid argument of the NhlCreate function.

Return values

If greater than 0, the value is the id of the user created App object that is currently being used as the default parent. Otherwise, it will return 0 to indicate that the internal HLU App object is active.

See also