Share via

IAMTimelineObj::GetLocked

  • Article
 
Microsoft DirectShow 9.0

IAMTimelineObj::GetLocked

The GetLocked method retrieves the object's editing state (locked or unlocked). A locked state indicates that the object should not be edited; an unlocked state indicates that the object can be edited. The timeline does not enforce the lock. The locked setting exists only for the convenience of the application.

Syntax

  GetLocked(
    BOOL *pVal
);

Parameters

pVal

Pointer to a Boolean variable that receives the object's editing state. If the value is TRUE, the object is locked and should not be edited. If FALSE, the object is unlocked and can be edited.

Return Value

Returns S_OK if successful, or E_POINTER otherwise.

Requirements

Header: Include Qedit.h. This header file is not compatible with Microsoft® Direct3D® headers later than version 7.

Library: Use strmiids.lib.

See Also