UlValidateParms

The UlValidateParms macro calls an internal function to check the parameters client applications have passed to service providers and MAPI.

Quick Info

Header file:	MAPIVAL.H
Implemented by:	MAPI
Called by:	Service providers

HRESULT UlValidateParms(
  METHODS eMethod,   
  LPVOID First       
);

Parameters

eMethod: [in] Specifies, by enumeration, the method to validate.
First: [in] Pointer to the first argument on the stack.

Return Values

S_OK: The call succeeded and has returned the expected value or values.
MAPI_E_CALL_FAILED: An error of unexpected or unknown origin prevented the operation from completing.

Remarks

Parameters passed between MAPI and service providers are assumed to be correct and undergo only debug validation with the CheckParms macro. Providers should check all parameters passed in by client applications, but clients should assume that MAPI and provider parameters are correct. Use the HR_FAILED macro to test return values.

The UlValidateParms macro is called differently depending on whether the calling code is C or C++. This macro is used to validate parameters for the few IUnknown and MAPI methods that return ULONG rather than HRESULT values; the ValidateParms macro works for all others.

For more information on parameter validation, see Validating Parameters to Interface Methods.