IMAPIControl::GetState

The IMAPIControl::GetState method retrieves a value that indicates whether the button control is enabled or disabled.

Quick Info

See IMAPIControl : IUnknown.

HRESULT GetState(
  ULONG ulFlags,         
  ULONG FAR * lpulState  
);
 

Parameters

ulFlags

Reserved; must be zero.

lpulState

[out] Pointer to a value indicating the state of the button control. One of the following values can be set:

MAPI_DISABLED

The button control is disabled and cannot be clicked.

MAPI_ENABLED

The button control is enabled and can be clicked.

Return Values

S_OK

The state of the button control was successfully retrieved.

Remarks

Service providers implement the IMAPIControl::GetState method to provide MAPI with the state of a button control. If enabled, the button can respond to a mouse click or key press. If disabled, the button appears dimmed and is incapable of responding to a mouse click or key press.

For more information about implementing GetState and the other IMAPIControl methods, see Implementing a Control Object.

See Also

IMAPIControl::Activate