safefilehandle.cs

本源码为OpenNETCF源代码

//==========================================================================================
//
//		OpenNETCF.Win32.SafeHandles.SafeFileHandle
//		Copyright (c) 2005, OpenNETCF.org
//
//		This library is free software; you can redistribute it and/or modify it under 
//		the terms of the OpenNETCF.org Shared Source License.
//
//		This library is distributed in the hope that it will be useful, but 
//		WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
//		FITNESS FOR A PARTICULAR PURPOSE. See the OpenNETCF.org Shared Source License 
//		for more details.
//
//		You should have received a copy of the OpenNETCF.org Shared Source License 
//		along with this library; if not, email [e-mail] to request a copy.
//
//		If you wish to contact the OpenNETCF Advisory Board to discuss licensing, please 
//		email [e-mail].
//
//		For general enquiries, email [e-mail] or visit our website at:
//		http://www.opennetcf.org
//
//==========================================================================================
using System;
using OpenNETCF.Runtime.InteropServices;

namespace OpenNETCF.Win32.SafeHandles
{
	/// <summary>
	/// Represents a wrapper class for file handles.
	/// <para><b>New in v1.3</b></para>
	/// </summary>
	public class SafeFileHandle : SafeHandleZeroOrMinusOneIsInvalid
	{
		/// <summary>
		/// Initializes a new instance of the <see cref="SafeFileHandle"/> class.
		/// </summary>
		/// <param name="preexistingHandle">The pre-existing handle to use.</param>
		/// <param name="ownsHandle">true to reliably release the handle during the finalization phase; otherwise, false (not recommended).</param>
		public SafeFileHandle(IntPtr preexistingHandle, bool ownsHandle) : base(ownsHandle)
		{
			base.SetHandle(preexistingHandle);
		}

		/// <summary>
		/// Executes the code required to free a handle.
		/// </summary>
		/// <returns>true if the handle is released successfully; false if a catastrophic failure occurs.</returns>
		protected override bool ReleaseHandle()
		{
			return Core.CloseHandle(handle);
		}

	}
}