Changeset 312


Ignore:
Timestamp:
Sep 24, 2017, 7:13:21 PM (3 years ago)
Author:
Valery V. Sedletski
Message:

ifs.inf: Additions to documentation.

Location:
trunk/src
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/ifsinf/ifs/ifs.ipf

    r285 r312  
    644644:p.The format of the OS/2 FS_ATTRIBUTE is defined in Figure 1-4 and the
    645645definition list that follows it&per.   
     646
    646647:cgraphic.
    647648:font facename='Courier' size=12x12. 31  30  29  28  27  26  25  24  23  22  21  20  19  18  17  16
     
    652653³ t ³ s ³ s ³ s ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³
    653654ÃÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄÅÄÄÄŽ
    654 ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ L ³ F ³ U ³ R ³
    655 ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ v ³ I ³ N ³ e ³
    656 ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ l ³ / ³ C ³ m ³
    657 ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ 7 ³ O ³   ³ t ³
     655³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ R ³ L ³ P ³ L ³ F ³ U ³ R ³
     656³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ e ³ R ³ S ³ v ³ I ³ N ³ e ³
     657³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ s ³ G ³ V ³ l ³ / ³ C ³ m ³
     658³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ v ³ F ³ R ³ 7 ³ O ³   ³ t ³
    658659ÀÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÁÄÄÄÙ
    659660 15  14  13  12  11  10   9   8   7   6   5   4   3   2   1   0
    660661
    661662:ecgraphic.
     663
    662664:font facename=default.
    663665:p.:hp2.Figure 1-4&per. OS/2 FSD Attribute :ehp2. 
     666
    664667:p.:hp2.Bits :ehp2.:hp2.Description :ehp2. 
     668
    665669:p.31 :hp2.FSD Additional attributes&per. :ehp2.If 1, FSD has additional attributes&per. If
    6666700, FS_ATTRIBUTE is the only FSD attribute information&per.   
     671
    667672:p.30-28 :hp2.VERSION NUMBER - FSD version number&per. :ehp2. 
    668 :p.27-4 :hp2.RESERVED :ehp2. 
     673
     674:p.27-:color fc=darkcyan.6:color fc=default. :hp2.RESERVED :ehp2. 
     675
     676:color fc=darkcyan.
     677:p.5 :hp2.LARGEFILE :ehp2.:color fc=darkcyan. - FSD supports large files with lengths larger than 2 GB&per. The sfi_sizel
     678and sfi_positionl fields are valid&per. They specify the 64-bit file length and 64-bit file position,
     679respectively&per.
     680
     681:p.If LARGEFILE bit is specified, the kernel will call the following additional FSD entry points instead&colon.
     682
     683:p.FS_CANCELLOCKREQUESTL
     684
     685:p.FS_CHGFILEPTRL
     686
     687:p.FS_FILELOCKSL
     688
     689:p.FS_NEWSIZEL
     690
     691:p.Except for FS_ATTRIBUTE, there is also FS32_ATTRIBUTE exported FSD variable&per. If it is exported, the FSD is
     692considered to be a 32-bit FSD by the kernel&per. FS32_ATTRIBUTE may be an alias to FS_ATTRIBUTE&per. Both of them
     693contain the same bit flags&per. When FS32_ATTRIBUTE is exported, the following new FSD exports are called by the
     694kernel&colon.
     695
     696:p.FS32_READ
     697
     698:p.FS32_READFILEATCACHE
     699
     700:p.FS32_RETURNFILECACHE
     701
     702:p.FS32_CHGFILEPTR (for seek with signed 32-bit position)
     703
     704:p.FS32_CHGFILEPTRL (for seek with signed 64-bit position)
     705
     706:p.FS32_WRITE
     707
     708:p.Also, functions like FS_FINDFIRST/FS_FINDNEXT/FS_PATHINFO/FS_FILEINFO get called with FIL_STANDARDL/FIL_QUERYEASIZEL/
     709FIL_QUERUYEASFROMLISTL, instead of FIL_STANDARD/FIL_QUERYEASIZE/FIL_QUERUYEASFROMLIST&per.
     710
     711:p.4 :hp2.PIPESVR :ehp2.:color fc=darkcyan. - FSD supports remote named pipes&per. If this bit is set, the kernel
     712will call FS_NMPIPE FSD entry point for pipes residing on remote servers&per.
     713
     714:color fc=default.
     715
    669716:p.3 :hp2.LEVEL7 - QPathInfo Level 7 bit&per. :ehp2.Set if FSD is case-preserving&per. If
    670717this bit is set, the kernel will call the FS_PATHINFO entry point with a level equal
    671718to 7&per. The output buffer is to be filled with a case-preserved copy of the path
    672719that was passed in by the user&per.   
     720
    673721:p.2 :hp2.FILEIO - File I/O bit&per. :ehp2.Set if FSD wants to see file locking/unlocking
    674722operations and compacted file I/O operations&per. If not set, the file I/O calls will be
     
    676724the lock/unlock calls&per. FSDs that do not support file locking can set this bit
    677725to enable compacted file I/O operations&per.   
     726
    678727:p.1 :hp2.UNC - Universal Naming Convention bit&per. :ehp2.Set if FSD supports the
    679728Universal Naming Convention&per. OS/2 Version 2&per.0 supports multiple loaded UNC
    680729redirectors&per.   
     730
     731:p.:color fc=darkcyan.When UNC flag is set, the FSD gets passed the UNC pathnames to FS_OPENCREATE/FS_FINDFIRST/FS_PATHINFO and
     732also FS_VERIFYUNCNAME is called to verify the UNC server ownership by a FSD&per.:color fc=default.
     733
    681734:p.0 :hp2.REMOTE - Remote File System (Redirector)&per. :ehp2.This bit tells the system
    682735whether the FSD uses static or dynamic media attachment&per. Local FSDs always use
     
    25332586equals the unlock range, an atomic lock will occur&per. If the ranges are not equal,
    25342587an error will be returned&per.   
     2588
    25352589:p.All other bits (2-31) are reserved and must be zero&per.
    25362590.br
    25372591
    25382592:p.:font facename='Helv' size=18x18.:color fc=darkcyan.:hp2.Remarks :ehp2.:font facename=default.:color fc=darkcyan.
     2593
    25392594:p.This entry point was added to support the 32-bit DosSetFileLocks API&per.   
     2595
    25402596:p.If the lock and unlock range lengths are both zero, an error, ERROR_LOCK_
    25412597VIOLATION will be returned to the caller&per. If only a lock is desired, pUnLockRange can
    25422598be NULL or both FileOffset and RangeLength should be set to zero when the call is
    25432599made&per. The opposite is true for an unlock&per.   
     2600
    25442601:p.When the atomic bit is not set, the unlock occurs first then the lock is
    25452602performed&per. If an error occurs on the unlock, an error is returned and the lock is not
     
    25522609operations&per. The application should also be sure to refresh its internal buffers prior
    25532610to making any modifications&per.   
     2611
    25542612:p.Closing a file with locks still in force causes the locks to be released in
    25552613no defined order&per.   
     2614
    25562615:p.Terminating a process with a file open and having issued locks on that file
    25572616causes the file to be closed and the locks to be released in no defined order&per.   
     2617
    25582618:p.The figure below describes the level of access granted when the accessed
    25592619region is locked&per. The locked regions can be anywhere in the logical file&per.
     
    25642624denied read or write access, but attempting to lock the region desired and examining
    25652625the error code&per.   
     2626
    25662627:p.:hp2.Locked Access Table :ehp2.:font facename='Courier' size=12x12.
     2628
    25672629:cgraphic.
    25682630:color fc=default.:color bc=default.:color fc=darkcyan.
     
    25792641
    25802642:ecgraphic.
     2643
    25812644:font facename=default.
    25822645:p.The locked access table has the actions on the left as to whether owners or
     
    25892652
    25902653:p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
     2654
    25912655:p.Provides the mechanism for an FSD to release resources allocated on behalf of
    25922656FS_FINDFIRST and FS_FINDNEXT&per.   
    2593 :p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     2657
     2658:p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     2659
    25942660:cgraphic.
    25952661:font facename='Courier' size=12x12.int far pascal FS_FINDCLOSE(pfsfsi, pfsfsd)
     
    25992665
    26002666:ecgraphic.
    2601 :font facename=default.
    2602 :p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     2667
     2668:font facename=default.
     2669:p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     2670
    26032671:p.pfsfsi is a pointer to the file-system-independent file search structure&per.   
     2672
    26042673:p.The FSD should not update this structure&per.   
     2674
    26052675:p.pfsfsd is a pointer to the file-system-dependent file search structure&per.   
     2676
    26062677:p.The FSD may use this to store information about continuation of its search
    26072678&per.
     
    26092680
    26102681:p.:font facename='Helv' size=18x18.:hp2.Remarks :ehp2.:font facename=default.
     2682
    26112683:p.DosFindClose has been called on the handle associated with the search buffer
    26122684&per. Any file system related information may be released&per.   
     2685
    26132686:p.If FS_FINDFIRST for a particular search returns an error, an FS_FINDCLOSE for
    26142687that search will not be issued&per.   
    2615 :h2 id=58.FS_FINDFIRST - Find First Matching File Name
    2616 
    2617 :p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
    2618 :p.Find first occurrence of a file name in a directory&per.   
    2619 :p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     2688
     2689:h2 id=58.FS_FINDFIRST - Find First Matching File Name:color fc=darkcyan.(s):color fc=default.
     2690
     2691:p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
     2692
     2693:p.Find first occurrence:color fc=darkcyan.(s):color fc=default. of a file name:color fc=darkcyan.(s):color fc=default. in a directory&per.   
     2694
     2695:p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     2696
    26202697:cgraphic.
    26212698:font facename='Courier' size=12x12.int far pascal FS_FINDFIRST(pcdfsi, pcdfsd, pName, iCurDirEnd, attr, pfsfsi,
     
    26342711unsigned short level;
    26352712unsigned short flags;
    2636 
    2637 :ecgraphic.
    2638 :font facename=default.
    2639 :p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
    2640 :p.pcdfsi is a pointer to the file-system-independent working directory
    2641 structure&per.   
    2642 :p.pcdfsd is a pointer to the file-system-dependent working directory structure
    2643 &per.   
     2713:ecgraphic.
     2714
     2715:font facename=default.
     2716
     2717:p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     2718
     2719:p.pcdfsi is a pointer to the file-system-independent working directory structure&per.
     2720
     2721:p.pcdfsd is a pointer to the file-system-dependent working directory structure&per.   
     2722
    26442723:p.pName is a pointer to the ASCIIZ name of the file or directory&per.   
     2724
    26452725:p.Wildcard characters are allowed only in the last component&per. The FSD does
    26462726not need to validate this pointer&per.   
     2727
    26472728:p.iCurDirEnd is the index of the end of the current directory in pName&per.   
    2648 :p.This is used to optimize FSD path processing&per. If iCurDirEnd == -1 there
    2649 is no current directory relevant to the name text, that is, a device&per.   
     2729
     2730:p.This :color fc=darkcyan.is provided to allow optimizations of:color fc=default. FSD path processing&per.
     2731If iCurDirEnd == -1 there is no current directory relevant to the name text, that is, a device&per.   
     2732
    26502733:p.attr is a bit field that governs the match&per.   
     2734
    26512735:p.Any directory entry whose attribute bit mask is a subset of attr and whose
    2652 name matches that in pName should be returned&per. For example, an attribute of
    2653 system and hidden is passed in&per. A file with the same name and an attribute of
    2654 system is found&per. This file is returned&per. A file with the same name and no
    2655 attributes (a regular file) is also returned&per. The attributes read-only and file-
    2656 archive will not be passed in and should be ignored when comparing directory attributes
    2657 &per.   
     2736name matches that in pName should be returned&per. :color fc=darkcyan.The attr field is two byte
     2737sized attribute bit masks&per.  The least significant byte contains the "may have" bits&per. For example,
     2738a "may have" attribute of system and hidden is passed in&per.:color fc=default. A file with the same name
     2739and an attribute of system is found&per. This file is returned&per. A file with the same name and no
     2740attributes (a regular file) is also returned&per. :color fc=darkcyan.The "may have" attributes read-only
     2741and file-archive will not be passed in and should be ignored when comparing directory attributes&per. The most
     2742significant byte contains the "must have" bits&per. A file with a matching name must also have the attributes in the
     2743"must have" bits to be returned&per. See the OS/2 Version 3&per.0 Control Program Programming Reference for
     2744more information about the attribute field under DosFindFirst&per.:color fc=default.
     2745
    26582746:p.The value of attr passed to the FSD will be valid&per. The bit 0x0040
    26592747indicates a non-8&per.3 filename format&per. It should be treated the same way as system
    2660 and hidden attributes are&per.   
     2748and hidden attributes are&per. :color fc=darkcyan.You should not return a file name that
     2749does not conform to 8&per.3 filename format if this bit is not set in the "may have" bits&per.
     2750:color fc=default.
     2751
    26612752:p.pfsfsi is a pointer to the file-system-independent file-search structure&per.   
     2753
    26622754:p.The FSD should not update this structure&per.   
     2755
    26632756:p.pfsfsd is a pointer to the file-system-dependent file-search structure&per.   
    2664 :p.The FSD may use this to store information about continuation of the search
    2665 &per.   
     2757
     2758:p.The FSD may use this to store information about continuation of the search&per.   
     2759
    26662760:p.pData is the address of the application data area&per.   
     2761
    26672762:p.Addressing of this data area is not validated by the kernel (see FSH_PROBEBUF
    2668 )&per. The FSD will fill in this area with a set of packed, variable- length
     2763)&per. The FSD will fill in this area with a set of packed, variable-length
    26692764structures that contain the requested data and matching file name&per.   
     2765
    26702766:p.cbData is the length of the application data area in bytes&per.   
     2767
    26712768:p.pcMatch is a pointer to the number of matching entries&per.   
     2769
    26722770:p.The FSD returns, at most, this number of entries; the FSD returns in this
    26732771parameter the number of entries actually placed in the data area&per.   
     2772
    26742773:p.The FSD does not need to validate this pointer&per.   
     2774
    26752775:p.level is the information level to be returned&per.   
    2676 :p.Level selects among a series of data structures to be returned&per. The level
    2677 passed to the FSD is valid&per.   
     2776
     2777:p.Level selects among a series of data structures to be returned&per. :color fc=darkcyan.(see below)
     2778:color fc=default. The level passed to the FSD is valid&per.   
     2779
    26782780:p.flags indicates whether to return file-position information&per.   
    2679 :p.flags == 0 indicates that file-position information should not be returned
    2680 and the information format described under DosFindFirst should be used&per.
    2681 .br
    2682 flags == 1 indicates that file-position information should be returned and the
     2781
     2782:p.flags == :color fc=darkcyan.FF_NOPOS (0x00):color fc=default. indicates that file-position information
     2783should not be returned :color fc=darkcyan.(see below):color fc=default.
     2784.br
     2785flags == :color fc=darkcyan.FF_GETPOS (0x01):color fc=default. indicates that file-position information should be returned and the
    26832786information format described below should be used&per.   
     2787
    26842788:p.The flag passed to the FSD has a valid value&per.
    26852789.br
    26862790
    26872791:p.:font facename='Helv' size=18x18.:hp2.Remarks :ehp2.:font facename=default.
    2688 :p.For flags == 1, the FSD must store in the first DWORD of the per-file
    2689 attributes structure adequate information to allow the search to be resumed from the file
    2690 by calling FS_FINDFROMNAME&per. For example, an ordinal representing the file
    2691 &apos.s position in the directory could be stored&per. If the filename must be used to
    2692 restart the search, the DWORD may be left blank&per.   
    2693 :p.For level 0x0001 and flags == 0, directory information for FS_FINDFIRST is
    2694 returned in the following format&colon.   
     2792
     2793:color fc=darkcyan.
     2794The find structure passed back to the user is the structure defined for the
     279516 bit DosFindFirst API with some modification if the flags parameter is set&per.
     2796The basic, level one FILEFINDBUF structure is:color fc=default.
     2797
    26952798:cgraphic.
    26962799:font facename='Courier' size=12x12.struct FileFindBuf {
     
    27072810    unsigned char  szName[];
    27082811}
    2709 
    2710 :ecgraphic.
     2812:ecgraphic.
     2813
     2814:p.For flags == 1, the FSD must store in the first DWORD of the per-file attributes structure adequate
     2815information :color fc=darkcyan.that in addition with the file name will allow:color fc=default. to be resumed
     2816from the file by calling FS_FINDFROMNAME&per. For example, an ordinal representing the file
     2817&apos.s position in the directory could be stored&per. If the filename must be used to
     2818restart the search, the DWORD may be left blank&per.   
     2819
    27112820:font facename=default.
    27122821:p.For level 0x0001 and flags == 1, directory information for FS_FINDFIRST is
    27132822returned in the following format&colon.   
     2823
    27142824:cgraphic.
    27152825:font facename='Courier' size=12x12.struct FileFromFindBuf {
     
    27282838    unsigned char  szName[];
    27292839}
    2730 
    2731 :ecgraphic.
     2840:ecgraphic.
     2841
    27322842:font facename=default.
    27332843:p.The other information levels have similar format, with the position the first
    2734 field in the structure for flags == 1&per.   
     2844field in the structure for flags == 1&per. :color fc=darkcyan.For level 0x0002 and flags == 1,
     2845directory information for FS_FINDFIRST is returned in the following format&colon.
     2846
     2847:cgraphic.
     2848:font facename='Courier' size=12x12.struct FileFromFindBuf  {
     2849    long              position;  /* this field is not present if flags */
     2850                                 /* is 0                               */
     2851    unsigned short  dateCreate;
     2852    unsigned short  timeCreate;
     2853    unsigned short  dateAccess;
     2854    unsigned short  timeAccess;
     2855    unsigned short   dateWrite;
     2856    unsigned short   timeWrite;
     2857    long                 cbEOF;
     2858    long               cbAlloc;
     2859    unsigned short        attr;
     2860    unsigned long       cbList;  /* size of EAs for the file           */
     2861    unsigned char       cbName;
     2862    unsigned char     szName";
     2863}
     2864:ecgraphic.
     2865
     2866For level 0x0003 and flags == 1, the directory information for FS_FINDFIRST
     2867is a bit more complicated&per. An EAOP structure will be located at the beginning
     2868of pData&per. You should start filling in the data after the EAOP structure&per.
     2869The data format is&colon.
     2870
     2871:cgraphic.
     2872:font facename='Courier' size=12x12.struct FileFromFindBuf  {
     2873    long              position;  /* this field is not present if flags */
     2874                                 /* is 0.                              */
     2875    unsigned short  dateCreate;
     2876    unsigned short  timeCreate;
     2877    unsigned short  dateAccess;
     2878    unsigned short  timeAccess;
     2879    unsigned short   dateWrite;
     2880    unsigned short   timeWrite;
     2881    long                 cbEOF;
     2882    long               cbAlloc;
     2883    unsigned short        attr;
     2884    FEALIST            fealist;  /* this is a variable length field    */
     2885    unsigned char       cbName;
     2886    unsigned char     szName";
     2887}
     2888:ecgraphic.
     2889
     2890:p.For a description of the FEALIST structure, see "FEAs" on page 1-10&per.
     2891
     2892:color fc=default.
     2893
    27352894:p.If the non-8&per.3 filename format bit is set in the attributes of a file
    27362895found by FS_FINDFIRST/NEXT/FROMNAME, it must be turned off in the copy of the
    27372896attributes returned in pData&per.   
     2897
    27382898:p.If FS_FINDFIRST for a particular search returns an error, an FS_FINDCLOSE for
    27392899that search will not be issued&per.   
     2900
    27402901:p.Sufficient information to find the next matching directory entry must be
    27412902saved in the fsfsd data structure&per.   
     2903
    27422904:p.In the case where directory entry information overflows the pData area, the
    27432905FSD should be able to continue the search from the entry which caused the overflow
    27442906on the next FS_FINDNEXT or FS_FINDFROMNAME&per.   
     2907
    27452908:p.In the case of a global search in a directory, the first two entries in that
    27462909directory as reported by the FSD should be &apos.&per.&apos. and &apos.&per.&per.&apos. (
    2747 current and the parent directories&per.   
    2748 :p.The example above just shows the effect of flags == 1 on a level 1 filefind
    2749 record; level 2 and level 3 filefind records are similarly affected&per.   
    2750 :p.:hp2.Note&colon.   :ehp2.The FSD will be called with the FINDFIRST/FINDFROMNAME interface
     2910current and the parent directories)&per.   
     2911
     2912:p.:hp2.NOTE&colon.   :ehp2.The FSD will be called with the FINDFIRST/FINDFROMNAME interface
    27512913when the 32-bit DosFindFirst/DosFindNext APIs are called&per. THIS IS A CHANGE FROM
    275229141&per.X IFS interface for redirector FSDs&per. The kernel will also be massaging
     
    27552917&per. You might want to reduce the size of the buffer sent to the server, so that the
    27562918position fields can be added to the beginning of all the find records)&per.   
     2919
     2920:p.:hp2.APPLICATION NOTE&colon.   :ehp2.:color fc=darkcyan.Some applications have been coded to expect behavior
     2921beyond the architectural requirements&per. For example, there are applications that require DosFindFirst to
     2922return an entry for a file that has been open-created, but which has never been closed&per. You can debate whether a file
     2923truly exists until it has been closed, but unless the applications are changed they will still not work&per.
     2924Consequently, it is recommended that FSDs exhibit this behavior&per.:color fc=default.
     2925
    27572926:h2 id=59.FS_FINDFROMNAME - Find matching file name starting from name
    27582927
    27592928:p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
     2929
    27602930:p.Find occurrence of a file name in a directory starting from a position or
    27612931name&per.   
     2932
    27622933:p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
    27632934:cgraphic.
     
    27772948:ecgraphic.
    27782949:font facename=default.
    2779 :p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     2950
     2951:p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     2952
    27802953:p.pfsfsi is a pointer to the file-system-independent file search structure&per.
    27812954The FSD should not update this structure&per.   
     2955
    27822956:p.pfsfsd is a pointer to the file-system-dependent file search structure&per.
    27832957The FSD may use this to store information about continuation of the search&per.   
     2958
    27842959:p.pData is the address of the application data area&per.   
     2960
    27852961:p.Addressing of this data area has not been validated by the kernel (see FSH_
    27862962PROBEBUF)&per. The FSD will fill in this area with a set of packed, variable- length
    27872963structures that contain the requested data and matching file names in the format required
    27882964for DosFindFirst/DosFindNext&per.   
     2965
    27892966:p.cbData is the length of the application data area in bytes&per.   
     2967
    27902968:p.pcMatch is a pointer to the number of matching entries&per. The FSD will
    27912969return at most this number of entries&per. The FSD will store into it the number of
    27922970entries actually placed in the data area&per. The FSD does not need to validate this
    27932971pointer&per.   
     2972
    27942973:p.level is the information level to be returned&per. Level selects among a
    27952974series of structures of data to be returned&per. The level passed to the FSD is valid
    27962975&per.   
     2976
    27972977:p.position is the file-system-specific information about where to restart the
    27982978search from&per. This information was returned by the FSD in the ResultBuf for an FS_
    27992979FINDFIRST/FS_FINDNEXT/FS_FINDFROMNAME call&per.   
     2980
    28002981:p.pName is the filename from which to continue the search&per. The FSD does not
    28012982need to validate this pointer&per.   
     2983
    28022984:p.flags indicates whether to return file position information&per. The flag
    28032985passed to the FSD has a valid value&per.
     
    28052987
    28062988:p.:font facename='Helv' size=18x18.:hp2.Remarks :ehp2.:font facename=default.
     2989
    28072990:p.The FSD may use the position or filename to determine the position > from
    28082991which to resume the directory search&per. The FSD need not return position if it uses
    28092992name and vice versa&per.   
     2993
    28102994:p.For flags == 1, the FSD must store in the position field adequate information
    28112995to allow the search to be resumed from the file by calling FS_FINDFROMNAME&per.
    28122996See FS_FINDFIRST for a description of the data format&per.   
     2997
    28132998:p.The FSD must ensure that enough information is stored in the fsfsd data
    28142999structure to enable it to continue the search&per.   
     3000
    28153001:p.:hp2.Note&colon.   :ehp2.The FSD will be called with the FINDFIRST/FINDFROMNAME interface
    28163002when the 32-bit DosFindFirst/DosFindNext APIs are called&per. THIS IS A CHANGE FROM
     
    28233009
    28243010:p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
     3011
    28253012:p.Find the next occurrence of a file name in a directory&per.   
    2826 :p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     3013
     3014:p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     3015
    28273016:cgraphic.
    28283017:font facename='Courier' size=12x12.int far pascal FS_FINDNEXT(pfsfsi, pfsfsd, pData, cbData, pcMatch, level,
     
    28383027
    28393028:ecgraphic.
    2840 :font facename=default.
    2841 :p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3029
     3030:font facename=default.
     3031:p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3032
    28423033:p.pfsfsi is a pointer to the file-system-independent file-search structure&per.
    28433034The FSD should not update this structure&per.   
     3035
    28443036:p.pfsfsd is a pointer to the file-system-dependent file-search structure&per.
    28453037The FSD may use this to store information about continuation of the search&per.   
     3038
    28463039:p.pData is the address of the application area&per.   
     3040
    28473041:p.Addressing of this data area is not validated by the kernel (see FSH_PROBEBUF
    28483042)&per. The FSD fills in this area with a set of packed, variable- length
    28493043structures that contain the requested data and matching file names&per.   
     3044
    28503045:p.cbData is the length of the application data area in bytes&per.   
     3046
    28513047:p.pcMatch is a pointer to the number of matching entries&per.   
     3048
    28523049:p.The FSD returns, at most, this number of entries&per. The FSD returns the the
    28533050number of entries actually placed in the data area in this parameter&per.   
     3051
    28543052:p.The FSD does not need to validate this pointer&per.   
     3053
    28553054:p.level is the information level to be returned&per.  Level selects among a
    28563055series of structures of data to be returned&per. The level passed to the FSD is valid
    28573056&per.   
     3057
    28583058:p.flags indicates whether to return file-position information&per.
    28593059.br
    28603060
    28613061:p.:font facename='Helv' size=18x18.:hp2.Remarks :ehp2.:font facename=default.
     3062
    28623063:p.For flags == -1, the FSD must store in the position field adequate
    28633064information to allow the search to be resumed from the file by calling FS_FINDFROMNAME&per.
    28643065See FS_FINDFIRST for a description of the data format&per.   
     3066
    28653067:p.The level passed to FS_FINDNEXT is the same level as that passed to FS_
    28663068FINDFIRST to initiate the search&per.   
     3069
    28673070:p.Sufficient information to find the next matching directory entry must be
    28683071saved in the fsfsd data structure&per.   
     3072
    28693073:p.The FSD should take care of the case where the pData area overflow may occur
    28703074&per. FSDs should be able to start the search from the same entry for the next FS_
    28713075FINDNEXT as the one for which the overflow occurred&per.   
     3076
    28723077:p.In the case of a global search in a directory, the first two entries in that
    28733078directory as reported by the FSD should be &apos.&per.&apos. and &apos.&per.&per.&apos. (
    28743079current and parent directories)&per.   
     3080
    28753081:h2 id=61.FS_FINDNOTIFYCLOSE - Close Find-Notify Handle
    28763082
    28773083:p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
     3084
    28783085:p.Closes the association between a Find-Notify handle and a DosFindNotifyFirst
    28793086or DosFindNotifyNext function&per.   
    2880 :p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     3087
     3088:p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     3089
    28813090:cgraphic.
    28823091:font facename='Courier' size=12x12.int far pascal FS_FINDNOTIFYCLOSE(handle)
     
    28853094
    28863095:ecgraphic.
    2887 :font facename=default.
    2888 :p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3096
     3097:font facename=default.
     3098:p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3099
    28893100:p.handle is the directory handle&per.   
     3101
    28903102:p.This handle was returned by the FSD on a previous FS_FINDNOTIFYFIRST or FS_
    28913103FINDNOTIFYNEXT call&per.
     
    28933105
    28943106:p.:font facename='Helv' size=18x18.:hp2.Remarks :ehp2.:font facename=default.
     3107
    28953108:p.Provides the mechanism for an FSD to release resources allocated on behalf of
    28963109FS_FINDNOTIFYFIRST and FS_FINDNOTIFYNEXT&per.   
     3110
    28973111:p.FS_FINDNOTIFYFIRST returns a handle to the find-notify request&per. FS_
    28983112FINDNOTIFYCLOSE closes the handle associated with that find-notify request and releases file
     
    29013115
    29023116:p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
     3117
    29033118:p.Start monitoring a directory for changes&per.   
    2904 :p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     3119
     3120:p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     3121
    29053122:cgraphic.
    29063123:font facename='Courier' size=12x12.int far pascal FS_FINDNOTIFYFIRST(pcdfsi, pcdfsd, pName, iCurDirEnd, attr,
     
    29203137
    29213138:ecgraphic.
    2922 :font facename=default.
    2923 :p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3139
     3140:font facename=default.
     3141:p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3142
    29243143:p.pcdfsi is a pointer to the file-system-independent working directory
    29253144structure&per.   
    2926 :p.pcdfsd is a pointer to the file-system-dependent working directory structure
    2927 &per.   
     3145
     3146:p.pcdfsd is a pointer to the file-system-dependent working directory structure&per.
     3147
    29283148:p.pName is a pointer to the ASCIIZ name of the file or directory&per.   
     3149
    29293150:p.Wildcard characters are allowed only in the last component&per. The FSD does
    29303151not need to verify this pointer&per.   
     3152
    29313153:p.iCurDirEnd is the index of the end of the current directory in pName&per.   
     3154
    29323155:p.This is used to optimize FSD path processing&per. If iCurDirEnd == -1 there
    29333156is no current directory relevant to the name text, that is, a device&per.   
     3157
    29343158:p.attr is the bit field that governs the match&per.   
     3159
    29353160:p.Any directory entry whose attribute bit mask is a subset of attr and whose
    29363161name matches that in pName should be returned&per. See FS_FINDFIRST for an
    29373162explanation&per.   
     3163
    29383164:p.pHandle is a pointer to the handle for the find-notify request&per.   
     3165
    29393166:p.The FSD allocates a handle for the find-notify request, that is, a handle to
    29403167the directory monitoring continuation information, and stores it here&per. This
    29413168handle is passed to FS_FINDNOTIFYNEXT to continue directory monitoring&per.   
     3169
    29423170:p.The FSD does not need to verify this pointer&per.   
     3171
    29433172:p.pData is the address of the application data area&per.   
     3173
    29443174:p.Addressing of this data area is not validated by the kernel (see FSH_PROBEBUF
    29453175)&per. The FSD fills in this area with a set of packed, variable- length
    29463176structures that contain the requested data and matching file names&per.   
     3177
    29473178:p.cbData is the length of the application data area in bytes&per.   
     3179
    29483180:p.pcMatch is a pointer to the number of matching entries&per.   
     3181
    29493182:p.The FSD returns, at most, this number of entries&per. The FSD returns in this
    29503183parameter the number of entries actually placed in the data area&per.   
     3184
    29513185:p.The FSD does not need to verify this pointer&per.   
     3186
    29523187:p.level is the information level to be returned&per.   
     3188
    29533189:p.Level selects among a series of data structures to be returned&per. See the
    29543190description of DosFindNotifyFirst in the :hp1.OS/2 Version 2&per.0 Control Program Programming
    29553191Reference :ehp1.for more information&per.   
     3192
    29563193:p.The level passed to the FSD is valid&per.   
     3194
    29573195:p.timeout is the time-out in milliseconds&per.   
     3196
    29583197:p.The FSD waits until either the time-out has expired, the buffer is full, or
    29593198the specified number of entries has been returned before returning to the caller
     
    29623201
    29633202:p.:font facename='Helv' size=18x18.:hp2.Remarks :ehp2.:font facename=default.
     3203
    29643204:p.None&per.   
    29653205:h2 id=63.FS_FINDNOTIFYNEXT - Resume reporting directory changes
    29663206
    29673207:p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
     3208
    29683209:p.Resume reporting of changes to a file or directory&per.   
    2969 :p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     3210
     3211:p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
     3212
    29703213:cgraphic.
    29713214:font facename='Courier' size=12x12.int far pascal FS_FINDNOTIFYNEXT(handle, pData, cbData, pcMatch, level,
     
    29803223
    29813224:ecgraphic.
    2982 :font facename=default.
    2983 :p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3225
     3226:font facename=default.
     3227:p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3228
    29843229:p.handle is the handle to the find-notify request&per.   
     3230
    29853231:p.This handle was returned by the FSD and is associated with a previous FS_
    29863232FINDNOTIFYFIRST or FS_FINDNOTIFYNEXT call&per.   
     3233
    29873234:p.pData is the address of the application data area&per.   
     3235
    29883236:p.Addressing of this data area is not validated by the kernel (see FSH_PROBEBUF
    29893237)&per. The FSD fills in this area with a set of packed, variable- length
    29903238structures that contain the requested data and matching file names&per.   
     3239
    29913240:p.cbData is the length of the application data area in bytes&per.   
     3241
    29923242:p.pcMatch is a pointer to the number of matching entries&per.   
     3243
    29933244:p.The FSD returns, at most, this number of entries&per. The FSD returns in this
    29943245parameter the number of entries actually placed in the data area&per.   
     3246
    29953247:p.The FSD does not need to verify this pointer&per.   
     3248
    29963249:p.level is the information level to be returned&per.   
     3250
    29973251:p.Level selects among a series of data structures to be returned&per. See the
    29983252description of DosFindNotifyFirst in the :hp1.OS/2 Version 2&per.0 Control Program Programming
    29993253Reference :ehp1.for more information&per.   
     3254
    30003255:p.The level passed to the FSD is valid&per.   
     3256
    30013257:p.timeout is the time-out in milliseconds&per.   
     3258
    30023259:p.The FSD waits until either the time-out has expired, the buffer is full, or
    30033260the specified number of entries has been returned before returning to the caller
     
    30063263
    30073264:p.:font facename='Helv' size=18x18.:hp2.Remarks :ehp2.:font facename=default.
     3265
    30083266:p.pcMatch is the number of changes required to directories or files that match
    30093267the pName target and attr specified during a related, previous FS_FINDNOTIFYFIRST
    30103268&per. The file system uses this field to return the number of changes that actually
    30113269occurred since the issue of the present FS_FINDNOTIFYNEXT&per.   
     3270
    30123271:p.The level passed to FS_FINDNOTIFYNEXT is the same level as that passed to FS_
    30133272FINDNOTIFYFIRST to initiate the search&per.   
     
    30153274
    30163275:p.:font facename='Helv' size=18x18.:hp2.Purpose :ehp2.:font facename=default.
     3276
    30173277:p.Flushes cache buffers for a specific volume&per.   
     3278
    30183279:p.:font facename='Helv' size=18x18.:hp2.Calling Sequence :ehp2.:font facename=default.
    30193280:cgraphic.
     
    30253286:ecgraphic.
    30263287:font facename=default.
    3027 :p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3288
     3289:p.:font facename='Helv' size=18x18.:hp2.Where :ehp2.:font facename=default.
     3290
    30283291:p.hVPB is the handle to the volume for flush&per.   
     3292
    30293293:p.flag is used to indicate discarding of cached data&per.   
     3294
    30303295:p.flag == 0 indicates cached data may be retained&per.
    30313296.br
    30323297flag == 1 indicates the FSD will discard any cached data after flushing it to
    30333298the specified volume&per.   
     3299
    30343300:p.All other values are reserved&per.
    30353301.br
    30363302
    30373303:p.:font facename='Helv' size=18x18.:hp2.Remarks :ehp2.:font facename=default.
     3304
    30383305:p.None&per.   
     3306
    30393307:h2 id=65.FS_FSCTL - File System Control
    30403308
  • trunk/src/makefile.mk

    r296 r312  
    350350.ipf.inf: .autodepend
    351351 @echo IPFC     $^.
    352  @$(IPFC) -i $< -o $(BINROOT)$^@ >nul 2>&1
     352 @ipfc -i $< $(BINROOT)$^@ >nul 2>&1
     353 #@wipfc -i $< -o $(BINROOT)$^@ >nul 2>&1
    353354
    354355.wmp.map:
Note: See TracChangeset for help on using the changeset viewer.