Close method
Collapse the table of content
Expand the table of content

IClosable.Close method

Releases system resources that are exposed by a Windows Runtime object.

.NET:  This interface appears as System.IDisposable.

C++/CX:  This interface appears as Platform::IDisposable.

Syntax


void Close()

Parameters

This method has no parameters.

Remarks

Implementation / caller notes that follow are mainly relevant for WRL.

Notes to implementers

Implement this method to release the exclusive system resources that are in use, such as file handles, streams, and network sockets. The method should also release other resources that are in use, including object references and memory, to prepare them for reuse.

This method must call the Close method of any object it holds that implements IClosable.

The Close method should release system resources as quickly as possible, without blocking for asynchronous operations to complete. To ensure that all resources are completely released, the caller must wait for all outstanding asynchronous operations to complete before calling Close.

After Close returns, the object is still in memory but without the system resources it needs; therefore, most of its members are not usable. A member that depends on a released system resource can return RO_E_CLOSED to indicate that the object is closed and it cannot complete the requested operation.

Notes to callers

If you call Close multiple times, there is no effect; the method returns S_OK.

Close methods aren't callable through Visual C++ component extensions (C++/CX) on Windows Runtime class instances where the class implemented IClosable. Instead, C++/CX code for runtime classes should call the destructor or set the last reference to null.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.FoundationContract, introduced version 1.0

Namespace

Windows::Foundation

Metadata

Windows.Foundation.FoundationContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

Windows::Foundation

Metadata

Windows.winmd

See also

IClosable

 

 

Show:
© 2017 Microsoft