SmsGetMessageSize (Compact 2013)

  • Article

3/26/2014

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
    Short Message Service (SMS) handle obtained from calling SmsOpen.
  • pdwDataSize
    Size (in bytes) of the buffer to allocate.

Return Value

  • E_FAIL
    Indicates an unspecified failure.
  • E_INVALIDARG
    Indicates one or more invalid arguments.
  • E_OUTOFMEMORY
    Indicates an out-of-memory error.
  • E_UNEXPECTED
    Unexpected failure.
  • 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

Header

sms.h

Library

sms.lib

See Also

Reference

Short Message Service Functions
SMS General Errors
SMS Specific Errors
SmsGetMessageSize
SmsReadMessage
SmsOpen