Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_LocStream), | intent(in) | :: | locstream | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_LocStreamValidate(locstream, keywordEnforcer, rc) ! ! !ARGUMENTS: type(ESMF_LocStream), intent(in) :: locstream type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below integer, intent(out), optional :: rc ! ! !DESCRIPTION: ! Validates that the {\tt locstream} is internally consistent. ! Currently this method determines if the {\tt locstream} is uninitialized ! or already destroyed. ! ! The method returns an error code if problems are found. ! ! The arguments are: ! \begin{description} ! \item [locstream] ! {\tt ESMF\_LocStream} to validate. ! \item [{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if the {\tt locstream} ! is valid. ! \end{description} ! !EOP integer :: localrc ! Initialize localrc = ESMF_RC_NOT_IMPL if (present(rc)) rc = ESMF_RC_NOT_IMPL ! check variables ESMF_INIT_CHECK_DEEP(ESMF_LocStreamGetInit,locstream,rc) ! return success if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_LocStreamValidate