SmsGetMessageSize (Windows Embedded CE 6.0)

1/6/2010

This function is used to determine an upper boundary for the size of the buffer that must be provided to SmsReadMessage when the next message is read.

Syntax

HRESULT SmsGetMessageSize (
  const SMS_HANDLE  smshHandle,
  DWORD* const      pdwDataSize
);

Parameters

• smshHandle
  A Short Message Service (SMS) handle obtained from calling SmsOpen.

• pdwDataSize
  Size (in bytes) of the buffer to allocate.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

• S_OK
  The method completed successfully.

For information about additional return values, see SMS Specific Errors and SMS General Errors.

Remarks

For efficiency reasons, SmsGetMessageSize may not return a value that exactly matches the size of the message. However, you are guaranteed to get a value that is at least large enough to hold the entire message.

Requirements

See Also

Reference

SmsReadMessage
SmsOpen

Concepts

Short Message Service Functions