IltmmMemory::LockBuffer

#include "ltmm.h"

C Syntax

HRESULT IltmmMemory_LockBuffer(pMem, pVal)

C++ Syntax

HRESULT LockBuffer(pVal)

 

IltmmMemory *pMem;

/* pointer to an interface */

VARIANT *pVal;

/* pointer to a VARIANT */

Locks the object's buffer to prevent access by any thread other than the calling thread.

Parameter

Description

pMem

Pointer to an IltmmMemory interface.

pVal

Pointer to a variable to be updated with a VARIANT containing a SAFEARRAY reference to the locked buffer.

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

This function obtains a pointer to the buffer in the form of a SAFEARRAY embedded in a VARIANT.

Call IltmmMemory::Unlock to unlock the buffer when it is no longer being used.

Required DLLs and Libraries

LTMM

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

Elements:

IltmmMemory::LockRegion, IltmmMemory::Unlock

Topics:

Multimedia Function Group

Example

For a C example, refer to Use ltmmMemory for Memory Conversion for C.

For a C++ example, refer to Use ltmmMemory for Memory Conversion for C++.