Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ICGetState macro

The ICGetState macro queries a video compression driver to return its current configuration in a block of memory. You can use this macro or explicitly call the ICM_GETSTATE message.

Syntax


DWORD ICGetState(
   hic,
   pv,
   cb
);

Parameters

hic

Handle of the compressor.

pv

Pointer to a block of memory to contain the current configuration information. You can specify NULL for this parameter to determine the amount of memory required for the configuration information, as in ICGetStateSize.

cb

Size, in bytes, of the block of memory.

Return value

If pv is NULL, returns the amount of memory, in bytes, required for configuration information.

If pv is not NULL, returns ICERR_OK if successful or an error otherwise.

Remarks

The ICGetStateSize macro returns the number of bytes used by the state data.

The structure used to represent configuration information is driver specific and is defined by the driver.

Use ICGetStateSize before calling the ICGetState macro to determine the size of buffer to allocate for the call.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Vfw.h

See also

Video Compression Manager
Video Compression Macros

 

 

Community Additions

Show:
© 2014 Microsoft