PushRouter_Open (Compact 2013)
3/26/2014
This function opens a communication channel for passing the push messages to the push router client.
Syntax
HRESULT PushRouter_Open(
LPCTSTR szContentType,
LPCTSTR szAppId,
HANDLE* pMsgAvailableEvent,
HPUSHROUTER* phPushRouter
);
Parameters
szContentType
[in] Pointer to the content type of the message routed to the push router client. The type is designated in a message header that identifies the push router client in the push router registration table.Note
For details about the Content-Type header, refer to WAP Specification "WAP-251-PushMessage-20010322-a.pdf" on OMA.
szAppId
[in] Pointer to the push application ID of the push router client. The ID is designated in a message header that identifies the push router client in the push router registration table.Note
For details about the Push Application ID, refer to WAP Specification "WAP-251-PushMessage-20010322-a.pdf" on OMA.
- pMsgAvailableEvent
[out] Pointer to a flag that signals the push router client when a message is available.
- phPushRouter
[out] Pointer to a handle to 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_ALREADYOPENED |
Another client with the same application ID and content type combination is already open. |
PUSHRTR_E_EXCEPTION |
An exception occurred in the push router function. |
PUSHRTR_E_NOTFOUND |
No registration exists for the client to be opened or unregistered. |
Remarks
Do not call the CloseHandle function with the message handle retrieved by PushRouter_Open.
Requirements
Header |
pushclient.h |
Library |
Pushprxy.lib |