DeleteLogMarshallingArea function (clfsw32.h)

  • Article

Deletes a marshaling area that is created by a successful call to CreateLogMarshallingArea.

When you delete a marshaling area it does the following:

  • Flushes the log to free pending log I/O blocks
  • Deallocates all log I/O blocks and invalidates all read contexts
The memory allocated by Common Log File System (CLFS) to create the marshaling context is reclaimed when all read contexts are terminated.
Note  Clients should not delete a marshaling area if there are pending operations on the marshaling area.
 

Syntax

CLFSUSER_API BOOL DeleteLogMarshallingArea(
  [in] PVOID pvMarshal
);

Parameters

[in] pvMarshal

A pointer to the opaque marshaling context allocated by using the CreateLogMarshallingArea function.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero (0). To get extended error information, call GetLastError. The following list identifies the possible error codes:

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 R2 [desktop apps only]
Target Platform Windows
Header clfsw32.h
Library Clfsw32.lib
DLL Clfsw32.dll

See also

Common Log File System Functions

CreateLogMarshallingArea