epoc32/include/pushentry.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// WAP Push Message Inline functions  File for the Utility class
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
/**
williamr@2
    21
 @file
williamr@2
    22
 @publishedPartner
williamr@2
    23
 @released
williamr@2
    24
*/
williamr@2
    25
williamr@2
    26
#include <msvapi.h>
williamr@2
    27
williamr@2
    28
inline const TMsvEntry& CPushMsgEntryBase::Entry() const
williamr@2
    29
/** 
williamr@2
    30
Gets the object's current message server index entry.
williamr@2
    31
williamr@2
    32
@return 
williamr@2
    33
Message server index entry 
williamr@2
    34
*/
williamr@2
    35
	{
williamr@2
    36
	return iEntry;
williamr@2
    37
	}
williamr@2
    38
williamr@2
    39
williamr@2
    40
inline TInt CPushMsgEntryBase::Status() const
williamr@2
    41
/** 
williamr@2
    42
Gets the Status value for the Push Message entry.
williamr@2
    43
williamr@2
    44
@return 
williamr@2
    45
Status value: a TPushMsgStatus value 
williamr@2
    46
*/
williamr@2
    47
	{
williamr@2
    48
	//The status value is one from an enumerated set. It is used to set Bits 0-3 
williamr@2
    49
	//of the iMtmData1 member of TMsvEntry. A bitwise AND is performed with iMtmData1 
williamr@2
    50
	//and a mask with value 0x000F to extract the status value.
williamr@2
    51
williamr@2
    52
	return iEntry.MtmData1() & KPushMaskOnlyStatus;//bitwise & to get Bits 0-3
williamr@2
    53
	}