Offline callback function

Marks a resource as unavailable for use after cleanup processing is complete. The POFFLINE_ROUTINE type defines a pointer to this function.

Syntax


DWORD WINAPI Offline(
  _In_ RESID Resource
);

typedef DWORD (WINAPI *POFFLINE_ROUTINE)(
    _In_ RESID Resource
);

Parameters

Resource [in]

Resource identifier for the resource to be taken offline.

Return value

ERROR_SUCCESS

0

The request completed successfully, and the resource is offline.

ERROR_IO_PENDING

997 (0x3E5)

The request is still pending, and a thread has been activated to process the offline request.

If the operation was not successful for other reasons, Offline should return one of the system error codes.

Remarks

If Offline returns an error code other than ERROR_IO_PENDING, the Resource Monitor logs an event and calls Terminate.

For effective implementation strategies of the Offline entry-point function, see Implementing Offline.

Examples

See Resource DLL Examples.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Enterprise, Windows Server 2008 Datacenter

Header

ResApi.h

See also

Resource DLL Entry Point Functions
NetShareDel

 

 

Show: