ILMNetSnk::GetUsername

#include "ILMNetSnk2.h"

C Syntax

HRESULT ILMNetSnk__getUsername(pNetSnk, Index, pVal)

C++ Syntax

HRESULT GetUsername(Index, pVal)

 

ILMNetSnk * pNetSnk;

/* pointer to an interface */

long Index;

/* index */

BSTR *pVal;

/* pointer to string */

Retrieves the username of the user at the specified index in the list of registered users.

Parameter

Description

pNetSnk

Pointer to an ILMNetSnk interface.

Index

A zero-based index of the user to retrieve its username from the list of registered users.

pVal

Pointer to a character string to be updated with the username of the user at the specified index in the users list.

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.

Comments

If the function succeeds, the user is responsible for freeing the retrieved username by calling SysFreeString.

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.

See Also

Functions:

ILMNetSnk::FindUser, ILMNetSnk::RemoveUser

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++.