CApNetworkItem Class Reference
      API published in: S60 1st Ed
API deprecated in: S60 3rd Ed FP 2
      
      Link against: apengine.lib 
      Capability Information
      Required Capabilities
       None
      Exceptions
      Functions modifying database (Create, Update, Delete) need WriteDeviceData.
         (CApDataHandler, CApUtils Setxxx functions)
      
      
#include <apnetworkitem.h>
      
      
Detailed Description
      < This class is used to hold the main information of a Network item. 
      
      
         It is used in CApNetworks. 
         
      
      
         
             | 
         
         
            
 Public Member Functions
             | 
         
         
            | virtual IMPORT_C  | 
            ~CApNetworkItem ()
             | 
         
         
            |   | 
            Destructor.  
  | 
         
         
            | IMPORT_C void  | 
            CopyFromL (const CApNetworkItem &aCopyFrom)
             | 
         
         
            |   | 
            Copies the data from another CApNetworkItem Substitutes the "Assignment operator.".  
  | 
         
         
            | IMPORT_C const TDesC &  | 
            Name () const 
             | 
         
         
            |   | 
            Gets the name of the network group Ownership of the returned text is not passed.  
  | 
         
         
            | IMPORT_C TUint32  | 
            Uid () const 
             | 
         
         
            |   | 
            Gets the UID of this network group.  
  | 
         
         
            | IMPORT_C void  | 
            SetUid (TUint32 aUid)
             | 
         
         
            |   | 
            Sets a UID of the network group.  
  | 
         
         
            | IMPORT_C void  | 
            SetNameL (const TDesC &aName)
             | 
         
         
            |   | 
            Sets the network name.  
  | 
         
         
            
 Static Public Member Functions
             | 
         
         
            | static IMPORT_C CApNetworkItem * 
             | 
            NewLC ()
             | 
         
         
            |   | 
            Two-phased constructor.  
  | 
         
         
            | static IMPORT_C CApNetworkItem * 
             | 
            NewLC (CApNetworkItem *aItem)
             | 
         
         
            |   | 
            Two-phased constructor.  
  | 
         
      
      
      
      Constructor & Destructor Documentation
      
         
            
               
               
                  
                     | virtual IMPORT_C CApNetworkItem::~CApNetworkItem            | 
                     (  | 
                                | 
                      )  | 
                      [virtual] | 
                   
                
               
             | 
         
      
      
      
      
      
      Member Function Documentation
      
         
            
               
               
                  
                     | IMPORT_C void CApNetworkItem::CopyFromL            | 
                     (  | 
                     const CApNetworkItem & 
                      | 
                      aCopyFrom          
                      | 
                      )  | 
                      | 
                   
                
               
             | 
         
      
      
      
         
            | 
                
               
             | 
            
               
               
                
                  Copies the data from another CApNetworkItem Substitutes the "Assignment operator.". 
                  
                
               
                  - Returns:
 
                  - No return value.
 
                
               
               
                  - Deprecated:
 
                  
                
               
             | 
         
      
      
         
            
               
               
                  
                     | IMPORT_C const TDesC& CApNetworkItem::Name            | 
                     (  | 
                                | 
                      )  | 
                      const | 
                   
                
               
             | 
         
      
      
      
         
            | 
                
               
             | 
            
               
               
                
                  Gets the name of the network group Ownership of the returned text is not passed. 
                  
                
               
                  - Returns:
 
                  - The name of the network group
 
                
               
               
                  - Deprecated:
 
                  
                
               
             | 
         
      
      
      
      
         
            | 
                
               
             | 
            
               
               
                
                  Two-phased constructor. 
                  
                
               
                  Leaves on failure, places instance on cleanup stack. 
                
               
                  - Parameters:
 
                  - 
                     
                     
                        
                            | 
                           aItem 
                            | 
                           a pointer to a CApNetworkItem.  | 
                         
                      
                     
                   
                
               
               
                  - Returns:
 
                  - The constructed CApNetworkItem.
 
                
               
               
                  - Deprecated:
 
                  
                
               
             | 
         
      
      
      
      
         
            | 
                
               
             | 
            
               
               
                
                  Two-phased constructor. 
                  
                
               
                  Leaves on failure, places instance on cleanup stack. 
                
               
                  - Returns:
 
                  - The constructed CApNetworkItem.
 
                
               
               
                  - Deprecated:
 
                  
                
               
             | 
         
      
      
         
            
               
               
                  
                     | IMPORT_C void CApNetworkItem::SetNameL            | 
                     (  | 
                     const TDesC &  | 
                      aName          
                      | 
                      )  | 
                      | 
                   
                
               
             | 
         
      
      
      
      
         
            
               
               
                  
                     | IMPORT_C void CApNetworkItem::SetUid            | 
                     (  | 
                     TUint32  | 
                      aUid          
                      | 
                      )  | 
                      | 
                   
                
               
             | 
         
      
      
      
         
            | 
                
               
             | 
            
               
               
                
                  Sets a UID of the network group. 
                  
                
               
                  - Parameters:
 
                  - 
                     
                     
                     
                  
 
                
               
               
                  - Deprecated:
 
                  
                
               
             | 
         
      
      
         
            
               
               
                  
                     | IMPORT_C TUint32 CApNetworkItem::Uid            | 
                     (  | 
                                | 
                      )  | 
                      const | 
                   
                
               
             | 
         
      
      
      
         
            | 
                
               
             | 
            
               
               
                
                  Gets the UID of this network group. 
                  
                
               
                  - Returns:
 
                  - The UID of this network group
 
                
               
               
                  - Deprecated:
 
                  
                
               
             | 
         
      
      
      
The documentation for this class was generated from the following file: