Release 4.0.0-preview1-00051
[platform/core/csapi/tizenfx.git] / 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 a unmanaged Bundle handle.
24     /// </summary>
25     public sealed class SafeBundleHandle : SafeHandle
26     {
27         /// <summary>
28         /// Initializes a new instance of the SafeBundleHandle class.
29         /// </summary>
30         public SafeBundleHandle() : base(IntPtr.Zero, true)
31         {
32         }
33
34         /// <summary>
35         /// Initializes a new instance of the SafeBundleHandle class.
36         /// </summary>
37         /// <param name="existingHandle">An IntPtr object that represents the pre-existing handle to use.</param>
38         /// <param name="ownsHandle">true to reliably release the handle during the finalization phase; false to prevent reliable release.</param>
39         public SafeBundleHandle(IntPtr existingHandle, bool ownsHandle) : base(IntPtr.Zero, ownsHandle)
40         {
41             SetHandle(existingHandle);
42         }
43
44         /// <summary>
45         /// Gets a value that indicates whether the handle is invalid.
46         /// </summary>
47         public override bool IsInvalid
48         {
49             get { return this.handle == IntPtr.Zero; }
50         }
51
52         /// <summary>
53         /// When overridden in a derived class, executes the code required to free the handle.
54         /// </summary>
55         /// <returns>true if the handle is released successfully</returns>
56         protected override bool ReleaseHandle()
57         {
58             Interop.Bundle.DangerousFree(this.handle);
59             this.SetHandle(IntPtr.Zero);
60             return true;
61         }
62     }
63 }