DeleteLogMarshallingArea function

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


BOOL WINAPI DeleteLogMarshallingArea(
  _In_  PVOID pvMarshal
);

Parameters

pvMarshal [in]

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:

ERROR_ACCESS_DENIED
ERROR_INVALID_HANDLE
ERROR_INVALID_PARAMETER
ERROR_IO_DEVICE

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 R2 [desktop apps only]

Header

Clfsw32.h

Library

Clfsw32.lib

DLL

Clfsw32.dll

See also

Common Log File System Functions
CreateLogMarshallingArea

 

 

Community Additions

ADD
Show:
© 2014 Microsoft