Animate_OpenEx macro (commctrl.h)

Article
10/23/2024

Opens an AVI clip from a resource in a specified module and displays its first frame in an animation control. You can use this macro or send the ACM_OPEN message explicitly.

Syntax

BOOL Animate_OpenEx(
   HWND      hwnd,
   HINSTANCE hInst,
   LPTSTR    szName
);

Parameters

hwnd

Type: HWND

A handle to the animation control.

hInst

Type: HINSTANCE

An instance handle to the module from which the resource should be loaded. If this value is NULL, the resource is loaded from the module that created the animation control.

szName

Type: LPTSTR

A pointer to a buffer that contains the path of the AVI file or the name of an AVI resource. Alternatively, this parameter can consist of the AVI resource identifier in the LOWORD and zero in the HIWORD. To create this value, use the MAKEINTRESOURCE macro. The control loads the AVI resource from the module specified by hInst. The AVI file or resource specified by szName must not contain audio.

If this parameter is NULL, the system closes the AVI file that was previously opened for the specified animation control, if any.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

Remarks

You can only open silent AVI clips. ACM_OPEN and Animate_Open will fail if szName specifies an AVI clip that contains sound.

You can use Animate_Close to close an AVI file or AVI resource that was previously opened for the specified animation control.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h

Share via