ICM_GETSTATE

The ICM_GETSTATE message is sent to a video compression driver to have it fill a block of memory describing the compressor’s current configuration.

Parameters

dwParam1

Specifies a pointer to a block of memory to be filled with the current state, or NULL. If NULL, return the amount of memory required by the state information.

dwParam2

Specifies the size of the block of memory.

Return Value

If dwParam1 is NULL, the driver returns the size of the configuration information. If dwParam1 is not NULL, and the value received in dwParam2 is less than size of the configuration information, the driver returns zero. Otherwise the driver returns the size of the information it returns in the structure supplied by dwParam1.

Comments

Client applications send this message with dwParam1 set to NULL to determine the size of the memory block required for obtaining the state information.

The data structure used to represent state information is driver-specific and is defined by the driver.