Export (0) Print
Expand All

4 Protocol Examples

A user subscribes to an RSS feed. The client polls the feed and finds a new item. The following is a description of what a client might do to accomplish the user's intentions and describes the responses a server might return. For information about the remote operations (ROPs) described in the example, see [MS-OXCPRPT] and [MS-OXCMSG].

Before manipulating RSS objects, the client asks the server to map named properties to property IDs by sending a RopGetPropertyIDsFromNamesROP request ([MS-OXCROPS] section 2.2.8.1).

Property

Property set GUID

LID or property name

PidLidPostRssChannel (section 2.2.1.5)

{00062041-0000-0000-C000-000000000046}

0x00008904

PidLidPostRssChannelLink (section 2.2.1.1)

{00062041-0000-0000-C000-000000000046}

0x00008900

PidLidPostRssItemGuid (section 2.2.1.4)

{00062041-0000-0000-C000-000000000046}

0x00008903

PidLidPostRssItemHash (section 2.2.1.3)

{00062041-0000-0000-C000-000000000046}

0x00008902

PidLidPostRssItemLink (section 2.2.1.2)

{00062041-0000-0000-C000-000000000046}

0x00008901

PidLidPostRssItemXml (section 2.2.1.6)

{00062041-0000-0000-C000-000000000046}

0x00008905

PidLidPostRssSubscription (section 2.2.1.7)

{00062041-0000-0000-C000-000000000046}

0x00008906

PidLidSideEffects ([MS-OXCMSG] section 2.2.1.16)

{00062008-0000-0000-C000-000000000046}

0x00008510

PidNameExchangeJunkEmailMoveStamp ([MS-OXCSPAM] section 2.2.1.2)

{00020329-0000-0000-C000-000000000046}

HTTP://schemas.microsoft.com/exchange/junkemailmovestamp

The server sends a RopGetPropertyIDsFromNamesROP response with the following property IDs, which will be used in the example that follows. (The actual property IDs are at the discretion of the server.)

Property

Property ID

PidLidPostRssChannel

0x8318

PidLidPostRssChannelLink

0x8314

PidLidPostRssItemGuid

0x8317

PidLidPostRssItemHash

0x8316

PidLidPostRssItemLink

0x8315

PidLidPostRssItemXml

0x8319

PidLidPostRssSubscription

0x831A

PidLidSideEffects

0x81F8

PidNameExchangeJunkEmailMoveStamp

0x8415

To create an RSS object, the client uses the RopCreateMessage ROP ([MS-OXCROPS] section 2.2.6.2). The server returns a success code and a handle to the object.

After processing the contents of the RSS item, the client transmits the properties to the server by using the RopSetProperties ROP ([MS-OXCROPS] section 2.2.8.6). The properties that are set are shown in the following table.

Property

Property ID

Data type

Value

PidLidPostRssChannel

0x8318

0x001F (PtypString ([MS-OXCDATA] section 2.11.1))

Help and How-To for Contoso

PidLidPostRssChannelLink

0x8314

0x001F

HTTP://www.contoso.com

PidLidPostRssItemGuid

0x8317

0x001F

HTTP://www.contoso.com

PidLidPostRssItemHash

0x8316

0x0003 (PtypInteger32 ([MS-OXCDATA] section 2.11.1))

0xCD0E93CF

PidLidPostRssItemLink

0x8315

0x001F

HTTP://www.contoso.com

PidLidPostRssItemXml

0x8319

0x001F

(See note 1 following the table.)

PidLidPostRssSubscription

0x831a

0x001F

Help and How-To for Contoso

PidLidSideEffects

0x81f8

0x0003

0x00000100

PidTagHtml ([MS-OXCMSG] section 2.2.1.56.9)

0x1013

0x0102 (PtypBinary ([MS-OXCDATA] section 2.11.1))

(See note 2 following the table.)

PidTagClientSubmitTime ([MS-OXOMSG] section 2.2.3.11)

0x0039

0x0040 (PtypTime ([MS-OXCDATA] section 2.11.1))

High: 0x01C87A36 Low: 0xD74C8CC0 (2008/02/28 18:22:13.900)

PidTagConversationTopic ([MS-OXOMSG] section 2.2.1.5)

0x0070

0x001F

Learn to narrow your search criteria for better searches in Contoso

PidTagInternetCodepage ([MS-OXCMSG] section 2.2.1.56.6)

0x3FDE

0x0003

0x0000FDE9

PidTagMessageClass ([MS-OXCMSG] section 2.2.1.3)

0x001A

0x001F

"IPM.Post.RSS"

PidTagMessageFlags ([MS-OXCMSG] section 2.2.1.6)

0x0E07

0x0003

Flags: 0x00000000 <none>

PidTagNormalizedSubject ([MS-OXCMSG] section 2.2.1.10)

0x0E1D

0x001F

Learn to narrow your search criteria for better searches in Contoso

PidTagSenderName (section 2.2.2.3)

0x0C1A

0x001F

Help and How-To for Contoso

PidTagSentRepresentingName (section 2.2.2.5)

0x0042

0x001F

Help and How-To for Contoso

PidTagSubjectPrefix ([MS-OXCMSG] section 2.2.1.9)

0x003D

0x001F

(null)

PidNameExchangeJunkEmailMoveStamp

0x8415

0x0003

0x802454D1

When the client has made all its changes to the item, it commits the properties to the server by using the RopSaveChangesMessage ROP ([MS-OXCROPS] section 2.2.6.3) and then releases the RSS object by using the RopRelease ROP ([MS-OXCROPS] section 2.2.15.3). The values of some properties will change during the processing of the RopSaveChangesMessage ROP, but the properties specified in this document will not change.

Note 1:   The PidLidPostRssItemXml property contains the following text.

<?xml version="1.0"?>
<item>
<title>Learn to narrow your search criteria for better searches in Contoso</title>
<description>Instant Search can help you find information in a flash.</description>
<link>http://www.contoso.com</link>
</item>

Note 2:   The PidTagHtml property contains the following text, encoded into binary as described in [MS-OXBBODY].

<html>
    <body>
        <table>
            <tr>
            <td>Instant Search can help you find information in a flash.</td>
            </tr>
        </table>
        <p><BR/><A HREF="http://www.contoso.com">View article...</A></p>
    </body>
</html>
Show:
© 2014 Microsoft