src/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18 using System.Runtime.InteropServices;
  19
  20 namespace Tizen.Applications
  21 {
  22     /// <summary>
  23     /// Represents a wrapper class for an unmanaged bundle handle.
  24     /// </summary>
  25     /// <since_tizen> 3 </since_tizen>
  26     public sealed class SafeBundleHandle : SafeHandle
  27     {
  28         /// <summary>
  29         /// Initializes a new instance of the SafeBundleHandle class.
  30         /// </summary>
  31         /// <since_tizen> 3 </since_tizen>
  32         public SafeBundleHandle() : base(IntPtr.Zero, true)
  33         {
  34         }
  35
  36         /// <summary>
  37         /// Initializes a new instance of the SafeBundleHandle class.
  38         /// </summary>
  39         /// <param name="existingHandle">An IntPtr object that represents the pre-existing handle to use.</param>
  40         /// <param name="ownsHandle">true to reliably release the handle during the finalization phase; false to prevent reliable release.</param>
  41         /// <since_tizen> 3 </since_tizen>
  42         public SafeBundleHandle(IntPtr existingHandle, bool ownsHandle) : base(IntPtr.Zero, ownsHandle)
  43         {
  44             SetHandle(existingHandle);
  45         }
  46
  47         /// <summary>
  48         /// Gets a value that indicates whether the handle is invalid.
  49         /// </summary>
  50         /// <since_tizen> 3 </since_tizen>
  51         public override bool IsInvalid
  52         {
  53             get { return this.handle == IntPtr.Zero; }
  54         }
  55
  56         /// <summary>
  57         /// When overridden in a derived class, executes the code required to free the handle.
  58         /// </summary>
  59         /// <returns>true if the handle is released successfully.</returns>
  60         protected override bool ReleaseHandle()
  61         {
  62             _ = Interop.Bundle.DangerousFree(this.handle);
  63             this.SetHandle(IntPtr.Zero);
  64             return true;
  65         }
  66     }
  67 }