PushRouter_RegisterClient (Compact 2013)
3/26/2014
This function registers a push router client with the push router registration table.
Syntax
HRESULT PushRouter_RegisterClient(
LPCTSTR szContentType,
LPCTSTR szAppId,
LPCTSTR szPath,
LPCTSTR szParams
);
Parameters
szContentType
[in] Pointer to the content type of the messages 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 the Open Mobile Alliance website at www.openmobilealliance.org.
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 the Open Mobile Alliance website at www.openmobilealliance.org.
- szPath
[in] Pointer to the push router client's executable file path.
- szParams
[in] Pointer to command-line parameters passed to the push router client.
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_ALREADYREGISTERED |
Another client is already registered with the same application ID and content type combination. |
PUSHRTR_E_EXCEPTION |
An exception occurred in the push router function. |
Remarks
During registration, the push router client must specify the types of routing entries it will be using: the push router client's content type, its push application ID, or both. The client makes one registration call per registration type: it makes one call for the content type, one call for the application ID, or one call for a combination of content type and application ID (three calls in all).
If your application is a trusted application, and another application is already registered with the same content type or application ID, the new registration will overwrite the old one.
Message routing priority is given to push router clients that register both content type and application ID. If the Content-Type and AppID headers do not agree, the push router will route the message based on the AppID header.
Requirements
Header |
pushclient.h |
Library |
Pushprxy.lib |