\hypertarget{interfacedc__args_1_1helpmsg}{}\section{dc\+\_\+args\+:\+:helpmsg Interface Reference}
\label{interfacedc__args_1_1helpmsg}\index{dc\+\_\+args\+::helpmsg@{dc\+\_\+args\+::helpmsg}}
\subsection*{Private Member Functions}
\begin{DoxyCompactItemize}
\item 
subroutine \hyperlink{interfacedc__args_1_1helpmsg_a49e07d64bceb76513488b538ec3c5513}{dcargshelpmsg0} (arg, category, msg)
\end{DoxyCompactItemize}


\subsection{Detailed Description}


Definition at line 294 of file dc\+\_\+args.\+f90.



\subsection{Member Function/\+Subroutine Documentation}
\mbox{\Hypertarget{interfacedc__args_1_1helpmsg_a49e07d64bceb76513488b538ec3c5513}\label{interfacedc__args_1_1helpmsg_a49e07d64bceb76513488b538ec3c5513}} 
\index{dc\+\_\+args\+::helpmsg@{dc\+\_\+args\+::helpmsg}!dcargshelpmsg0@{dcargshelpmsg0}}
\index{dcargshelpmsg0@{dcargshelpmsg0}!dc\+\_\+args\+::helpmsg@{dc\+\_\+args\+::helpmsg}}
\subsubsection{\texorpdfstring{dcargshelpmsg0()}{dcargshelpmsg0()}}
{\footnotesize\ttfamily subroutine dc\+\_\+args\+::helpmsg\+::dcargshelpmsg0 (\begin{DoxyParamCaption}\item[{type(\hyperlink{structdc__args_1_1args}{args}), intent(inout)}]{arg,  }\item[{character($\ast$), intent(in)}]{category,  }\item[{character($\ast$), intent(in)}]{msg }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



Definition at line 663 of file dc\+\_\+args.\+f90.


\begin{DoxyCode}
663     \textcolor{comment}{!}
664     \textcolor{comment}{! ヘルプメッセージを追加します. }
665     \textcolor{comment}{!}
666     \textcolor{comment}{! サブルーチン DCArgsHelp を使用した際に出力されるメッセージを}
667     \textcolor{comment}{! 付加します. *category* に +Title+, +Overview+, +Usage+ が}
668     \textcolor{comment}{! 指定されたものは +Options+ よりも上部に,}
669     \textcolor{comment}{! それ以外のものは下部に表示されます.}
670     \textcolor{comment}{! *msg* にはメッセージを与えてください.}
671     \textcolor{comment}{!}
672     \textcolor{comment}{!=== 例}
673     \textcolor{comment}{!}
674     \textcolor{comment}{!     program dc\_args\_sample3}
675     \textcolor{comment}{!       use dc\_types}
676     \textcolor{comment}{!       use dc\_string, only: StoA}
677     \textcolor{comment}{!       use dc\_args}
678     \textcolor{comment}{!       implicit none}
679     \textcolor{comment}{!       type(ARGS) :: arg}
680     \textcolor{comment}{!       logical :: OPT\_namelist}
681     \textcolor{comment}{!       character(STRING) :: VAL\_namelist}
682     \textcolor{comment}{!       character(STRING), pointer :: argv(:) => null()}
683     \textcolor{comment}{!       integer :: i}
684     \textcolor{comment}{!}
685     \textcolor{comment}{!       call DCArgsOpen( arg = arg )   ! (out)}
686     \textcolor{comment}{!       call DCArgsHelpMsg( arg = arg, &              ! (inout)}
687     \textcolor{comment}{!         & category = 'Title', &                     ! (in)}
688     \textcolor{comment}{!         & msg = 'dcargs $Revision: 1.2 $ ' // &}
689     \textcolor{comment}{!         &       ':: Test program of dc\_args' )      ! (in)}
690     \textcolor{comment}{!       call DCArgsHelpMsg( arg = arg, &              ! (inout)}
691     \textcolor{comment}{!         & category = 'Usage', &                     ! (in)}
692     \textcolor{comment}{!         & msg = 'dcargs [Options] arg1, arg2, ...') ! (in)}
693     \textcolor{comment}{!       call DCArgsOption( arg = arg, &           ! (inout)}
694     \textcolor{comment}{!         & options = StoA('-N', '--namelist'), & ! (in)}
695     \textcolor{comment}{!         & flag = OPT\_namelist, &                ! (out)}
696     \textcolor{comment}{!         & value = VAL\_namelist, &               ! (out)}
697     \textcolor{comment}{!         & help = "Namelist filename")           ! (in)}
698     \textcolor{comment}{!       call DCArgsHelpMsg( arg = arg, &          ! (inout)}
699     \textcolor{comment}{!         & category = 'DESCRIPTION', &           ! (in)}
700     \textcolor{comment}{!         & msg = '(1) Define type "HASH". ' // &}
701     \textcolor{comment}{!         &       '(2) Open the variable. ' // &}
702     \textcolor{comment}{!         &       '(3) set HelpMsg. ' // &}
703     \textcolor{comment}{!         &       '(4) set Options. ' // &}
704     \textcolor{comment}{!         &       '(5) call Debug. ' // &}
705     \textcolor{comment}{!         &       '(6) call Help. ' // &}
706     \textcolor{comment}{!         &       '(7) call Strict.')             ! (in)}
707     \textcolor{comment}{!       call DCArgsHelpMsg( arg = arg, &                         ! (inout)}
708     \textcolor{comment}{!         & category = 'Copyright', &                            ! (in)}
709     \textcolor{comment}{!         & msg = 'Copyright (C) ' // &}
710     \textcolor{comment}{!         &       'GFD Dennou Club, 2008. All rights reserved.') ! (in)}
711     \textcolor{comment}{!       call DCArgsDebug( arg = arg )  ! (inout)}
712     \textcolor{comment}{!       call DCArgsHelp( arg = arg )   ! (inout)}
713     \textcolor{comment}{!       call DCArgsStrict( arg = arg ) ! (inout)}
714     \textcolor{comment}{!       call DCArgsGet( arg = arg, &   ! (inout)}
715     \textcolor{comment}{!         & argv = argv )              ! (out)}
716     \textcolor{comment}{!       write(*,*) '--namelist=', trim( VAL\_namelist )}
717     \textcolor{comment}{!       do i = 1, size(argv)}
718     \textcolor{comment}{!         write(*,*) argv(i)}
719     \textcolor{comment}{!       end do}
720     \textcolor{comment}{!       deallocate( argv )}
721     \textcolor{comment}{!       call DCArgsClose( arg = arg )  ! (inout)}
722     \textcolor{comment}{!     program dc\_args\_sample3}
723     \textcolor{comment}{!}
724     \textcolor{comment}{! コマンドライン引数に '-h', '-H', '--help' のいづれかのオプション}
725     \textcolor{comment}{! を指定することで, HelpMsg で与えたメッセージと, オプションの一覧}
726     \textcolor{comment}{! が標準出力に表示されます.}
727     \textcolor{comment}{!}
728     \textcolor{keywordtype}{use }\hyperlink{namespacedc__hash}{dc\_hash}\textcolor{keywordtype}{, only}: \hyperlink{interfacedc__hash_1_1dchashput}{dchashput}
729     \textcolor{keywordtype}{use }\hyperlink{namespacedc__string}{dc\_string}\textcolor{keywordtype}{, only}: \hyperlink{interfacedc__string_1_1uchar}{uchar}
730     \textcolor{keywordtype}{use }\hyperlink{namespacedc__message}{dc\_message}\textcolor{keywordtype}{, only}: \hyperlink{interfacedc__message_1_1messagenotify}{messagenotify}
731     \textcolor{keywordtype}{implicit none}
732     \textcolor{keywordtype}{type}(args), \textcolor{keywordtype}{intent(inout)} :: arg
733     \textcolor{keywordtype}{character(*)}, \textcolor{keywordtype}{intent(in)} :: category
734     \textcolor{keywordtype}{character(*)}, \textcolor{keywordtype}{intent(in)} :: msg
735     \textcolor{keywordtype}{character(len = *)}, \textcolor{keywordtype}{parameter}  :: subname = \textcolor{stringliteral}{'DCArgsHelpMsg'}
736   \textcolor{keywordflow}{continue}
737     \textcolor{keywordflow}{if} (.not. arg % initialized) \textcolor{keywordflow}{then}
738       \textcolor{keyword}{call }\hyperlink{interfacedc__message_1_1messagenotify}{messagenotify}(\textcolor{stringliteral}{'W'}, subname, \textcolor{stringliteral}{'Call Open before Help in dc\_args.'})
739       \textcolor{keyword}{call }dcargsopen(arg)
740 \textcolor{keywordflow}{    end if}
741     \textcolor{keyword}{call }\hyperlink{interfacedc__hash_1_1dchashput}{dchashput}(arg % helpmsg, key=\hyperlink{interfacedc__string_1_1uchar}{uchar}(category), \textcolor{keywordtype}{value}=msg)
\end{DoxyCode}


The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
dc\+\_\+utils/\hyperlink{dc__args_8f90}{dc\+\_\+args.\+f90}\end{DoxyCompactItemize}
