Keywords: class-user

Next: API summary Up: User hook for command Previous: Example Contents

### API

The following subroutines have to be used to declare user's find subroutine:

- Declare the user's dump find routines:

        subroutine class_user_find(userfind)
          external :: userfind  ! User's 'find' subroutine (command line parsing)
        subroutine class_user_fix(userfix)
          external :: userfix  ! User's 'find' subroutine (selection)

The calling sequence of the user's find routines must be of the following form:

    subroutine userfind(arg,narg,error)
      integer(kind=4),  intent(in)    :: narg       ! Number of arguments
      character(len=*), intent(in)    :: arg(narg)  ! Arguments
      logical,          intent(inout) :: error      ! Logical error flag

    subroutine userfix(version,found,error)
      integer(kind=4), intent(in)    :: version  ! The version of the data
      logical,         intent(out)   :: found    ! Selected or not selected?
      logical,         intent(inout) :: error    ! Logical error flag

The name of these subroutines is free.