Home > vbmeg > external > yokogawa_lib > getYkgwHdrBookmark.m

getYkgwHdrBookmark

PURPOSE ^

Get header of bookmark

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

 Get header of bookmark
 [ Yokogawa MEG Reader toolbox for MATLAB ]

 brief:
   This function retrieves information about bookmark in the specified file.

 usage:
   bookmark = getYkgwHdrBookmark(filepath)

 arguments:
   filepath            : file path

 return values:
   bookmark            : structure array of bookmark
     .sample_no        : double, sample number of bookmark
     .label            : double, label of bookmark
     .comment          : double, comment of bookmark

 rivision history
   2 : 2011.03.03 : Structure fields (reference_no, type) which had not been used were removed.
   1 : 2011.02.14 : 1st argument is modified from file ID to file path.
   0 : 2010.06.24 : first release
 
 Copyright (C) 2010-2011 Yokogawa Electric Corporation, All Rights Reserved.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % Get header of bookmark
0002 % [ Yokogawa MEG Reader toolbox for MATLAB ]
0003 %
0004 % brief:
0005 %   This function retrieves information about bookmark in the specified file.
0006 %
0007 % usage:
0008 %   bookmark = getYkgwHdrBookmark(filepath)
0009 %
0010 % arguments:
0011 %   filepath            : file path
0012 %
0013 % return values:
0014 %   bookmark            : structure array of bookmark
0015 %     .sample_no        : double, sample number of bookmark
0016 %     .label            : double, label of bookmark
0017 %     .comment          : double, comment of bookmark
0018 %
0019 % rivision history
0020 %   2 : 2011.03.03 : Structure fields (reference_no, type) which had not been used were removed.
0021 %   1 : 2011.02.14 : 1st argument is modified from file ID to file path.
0022 %   0 : 2010.06.24 : first release
0023 %
0024 % Copyright (C) 2010-2011 Yokogawa Electric Corporation, All Rights Reserved.

Generated on Mon 22-May-2023 06:53:56 by m2html © 2005