Share via

PushRouter_GetMessage (Compact 2013)

  • Article

3/26/2014

This function passes the message to the push router client.

Syntax

HRESULT PushRouter_GetMessage(
  HPUSHROUTER hPushRouter,
  LPPUSHMSG pPushMsg
);

Parameters

  • hPushRouter
    [in] Handle to the push router.
  • pPushMsg
    [out] Pointer to a PUSHMSG structure, which represents the message provided by the push router.

Return Value

Returns S_OK if successful. If the function is unsuccessful, it can return a standard Windows HRESULT value or one of the push router-specific HRESULT values shown in the following table.

Value

Description

PUSHRTR_E_EXCEPTION

An exception occurred in the push router function.

PUSHRTR_S_NOMESSAGEPENDING

No messages are pending in the client queue.

Requirements

Header

pushclient.h

Library

Pushprxy.lib

See Also

Reference

WAP Functions
PushRouter_FreeMessage
PUSHMSG