en:docs:fapi:dosbufreset

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:docs:fapi:dosbufreset [2020/12/06 10:39] – prokusheven:docs:fapi:dosbufreset [2021/09/17 03:39] (current) – prokushev
Line 1: Line 1:
-{{logos:os2.gif?35x35}} {{logos:dos.gif?35x35}}+{{page>en:templates:fapiint}}
  
 ====== DosBufReset ====== ====== DosBufReset ======
Line 5: Line 5:
 This call flushes a requesting process's cache buffers for a specific file handle or for all file handles attached to that process. This call is also used with the handle of a named pipe to synchronize a dialog between communicating processes. This call flushes a requesting process's cache buffers for a specific file handle or for all file handles attached to that process. This call is also used with the handle of a named pipe to synchronize a dialog between communicating processes.
  
-==Syntax==+===== Syntax ===== 
 + 
 +<code c> 
 +DosBufReset (FileHandle) 
 +</code> 
 + 
 +===== Parameters =====
  
-  DosBufReset (FileHandle) 
  
-==Parameters==+  *FileHandle ([[HFILE]]) - input : File handle whose buffers are to be flushed. If FileHandle = 0xFFFFH, all of the process's file handles are flushed.
  
-  *FileHandle (HFILE) - input : File handle whose buffers are to be flushed. If FileHandle = 0xFFFFH, all of the process's file handles are flushed.+===== Return Code =====
  
-==Return Code== + rc ([[USHORT]]) - return
-  rc (USHORT) - return+
      
 Return code descriptions are: Return code descriptions are:
Line 23: Line 27:
   * 6        ERROR_INVALID_HANDLE   * 6        ERROR_INVALID_HANDLE
  
-==Remarks==+===== Remarks ===== 
  
 Upon issuing DosBufReset for a file handle, the file's buffers are flushed to disk and its directory entry updated as if the file had been closed; however the file remains in an open state. Upon issuing DosBufReset for a file handle, the file's buffers are flushed to disk and its directory entry updated as if the file had been closed; however the file remains in an open state.
Line 29: Line 34:
 Usage of this call to write out all files belonging to the requesting process should be administered with caution. When the files reside on removable media (diskettes), a call to DosBufReset could have the undesirable effect of requiring the user to insert and remove a large number of diskettes. Usage of this call to write out all files belonging to the requesting process should be administered with caution. When the files reside on removable media (diskettes), a call to DosBufReset could have the undesirable effect of requiring the user to insert and remove a large number of diskettes.
  
-===Named Pipe Considerations===+====Named Pipe Considerations====
  
 Issuing DosBufReset for a named pipe performs an operation that is analogous to forcing the buffer cache to disk. The request blocks the calling process at one end of the pipe until all data it has written has been read at the other end of the pipe. Issuing DosBufReset for a named pipe performs an operation that is analogous to forcing the buffer cache to disk. The request blocks the calling process at one end of the pipe until all data it has written has been read at the other end of the pipe.
  
-==Example Code== +===== Example Code ===== 
-===C Binding===+ 
 +==== C Binding ==== 
 <code c> <code c>
  
Line 93: Line 100:
 </code> </code>
  
-===MASM Binding===+==== MASM Binding ==== 
 <code asm> <code asm>
 EXTRN  DosBufReset:FAR EXTRN  DosBufReset:FAR
Line 103: Line 111:
 Returns WORD Returns WORD
  
-====== Note ======+===== Note ===== 
  
 Text based on [[http://www.edm2.com/index.php/DosBufReset]] Text based on [[http://www.edm2.com/index.php/DosBufReset]]