FIO_CONTEXT

[This is preliminary documentation and subject to change.]

The FIO_CONTEXT structure defines a context object used to represent file handles. The AssociateFile function returns a pointer to an instance of this structure given a file HANDLE created using CreateFile using the FILE_FLAG_OVERLAPPED dwFlagsAndAttributes flag.

struct  FIO_CONTEXT {
  DWORD   m_dwTempHack ;       // not used. Set to NULL
  DWORD   m_dwSignature ;      // context signature
  HANDLE  m_hFile ;            // file handle (FILE_FLAG_OVERLAPPED)
  DWORD   m_dwLinesOffset;     // The offset to back fill Lines header 
  DWORD   m_dwHeaderLength;    //  Header length (NNTP only)
};
typedef  FIO_CONTEXT*  PFIO_CONTEXT ;

Members

m_dwTempHack

Not used. Set to NULL.

m_dwSignature

A context signature used to identify the origin of the object.

m_hFile

A file HANDLE created with the FILE_FLAG_OVERLAPPED option.

m_dwLinesOffset

The offset used to back-fill Lines header (NNTP only).

m_dwHeaderLength

The header length (NNTP only).

Remarks

The FIO_CONTEXT structure is used with various MailMsg object file I/O operations. It essentially wraps a file HANDLE created with the CreateFile function. Use the AssociateFile function to create this structure for use with the MailMsg object.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in filehc.h; include filehc.h.

See Also

AssociateFile, ReleaseContext, CreateFile, OVERLAPPED