IltmmMemory::LockRegion

Summary

Locks a region in the objects buffer.

Syntax

#include "ltmm.h"

Language Syntax
C HRESULT IltmmMemory_LockRegion(pMem, Index, Count, pVal)
C++ HRESULT LockRegion(Index, Count, pVal)

Parameters

IltmmMemory *pMem

Pointer to an IltmmMemory interface.

long Index

Zero based index, or offset, of the region to lock.

long Count

Size of the region to lock, in bytes.

VARIANT *pVal

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

Returns

Value Meaning
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 requested size of the region is larger than the size available after the offset, the function locks only the region between the offset and the end of the buffer.

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

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

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

Language Example
C Use ltmmMemory for Memory Conversion
C++ Use ltmmMemory for Memory Conversion
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.