lineShutdown (Compact 2013)

3/26/2014

This function shuts down the application's usage of the line abstraction of the API.

Syntax

LONG lineShutdown(
  HLINEAPP hLineApp
);

Parameters

  • hLineApp
    [in] Application's usage handle for the line API.

Return Value

Zero indicates success. A negative error number indicates that an error occurred. The following table shows the return values for this function.

Value

Description

LINEERR_INVALAPPHANDLE

The app handle is invalid.

LINEERR_NOMEM

Not enough memory is available.

LINEERR_RESOURCEUNAVAIL

The resource is unavailable.

LINEERR_UNINITIALIZED

The parameter is uninitialized.

Remarks

If this function is called when the application has lines open or calls active, the call handles are deleted and TAPI automatically performs the equivalent of a lineClose on each open line. However, it is recommended that applications explicitly close all open lines before invoking lineShutdown. If shutdown is performed while asynchronous requests are outstanding, those requests are canceled.

Requirements

Header

tapi.h

Library

TAPI32.dll

See Also

Reference

TAPI Line Device Functions
lineClose