ILMNetSnkConnection::get_Enabled

#include "ILMNetSnk2.h"

C Syntax

HRESULT ILMNetSnkConnection_get_Enabled(pCon, pVal)

C++ Syntax

HRESULT get_Enabled(pVal)

 

ILMNetSnkConnection * pCon;

/* pointer to an interface */

VARIANT_BOOL *pVal;

/* pointer to a variable*/

Retrieves a value that indicates whether this connection is enabled.

Parameter

Description

pCon

Pointer to an ILMNetSnkConnection interface.

pVal

Pointer to a variable to be updated with a value that indicates whether this connection is enabled. Possible values are:

 

Value

Description

 

VARIANT_TRUE

The connection is enabled. The media samples are delivered normally to the client at the other end of the connection. This is the default value.

 

VARIANT_FALSE

The connection is disabled. The connection is still alive, but no media samples are delivered to the client at the other end of the connection.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Required DLLs and Libraries

LMNetSnk
DSKernel
LMNetCon

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Functions:

ILMNetSnkConnection::put_Enabled, ILMNetSnkConnection::get_Connected, ILMNetSnkConnection::Close

Topics:

Video Streaming Function Groups, Multimedia Function Group, DVD Function Groups

Example

For a C example, refer to The Server Side Example for C.

For a C++ example, refer to The Server Side Example for C++.