Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function causes a session to time out.

Syntax

NTSTATUS TimeoutSession( 
  PVOID 
EditorHandle, 
  PVOID 
SessionHandle 
)

Parameters

EditorHandle

[in] Pointer that specifies the handle that identifies the editor to a network address translation (NAT) module.

SessionHandle

[in] Handle to the session. Use this handle when calling the QueryInfoSessionfunction.

Return Value

STATUS_SUCCESS indicates success. A non-zero value indicates failure.

Remarks

Calling TimeoutSessionends the session and removes all of the port mappings for that session. Once the port mappings are removed, no further translation occurs on the session. The NAT driver removes port mappings asynchronously, so translation might not stop immediately.

Requirements

Header natedit.h
Library coredll.dll
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also