CFLib.org – SetReadOnly

SetReadOnly(sFilePath, bReadOnly)

Last updated September 27, 2001

Download UDF

author

Nate Weiss
Send Email

Version: 1 | Requires: ColdFusion 5 | Library: FileSysLib

Rated 0 time(s). Average Rating: 0

Description:
Convenience function to set/clear the ReadOnly attribute for the specified file.

Return Values:
Returns a Boolean value indicating whether the attribute was set.

Example:

view plain print about

<CFSET x = SetReadOnly("c:\myfile.txt", "Yes")>

<CFOUTPUT>
Was the attribute set? #YesNoFormat(x)#
</CFOUTPUT>

<CFSET x = SetReadOnly("c:\myfile.txt", "Yes")>

<CFOUTPUT>
Was the attribute set? #YesNoFormat(x)#
</CFOUTPUT>

Parameters:

Name	Description	Required
sFilePath	Absolute or relative path to the specified file.	Yes
bReadOnly	Boolean value indicating whether the attribute should be read only (Yes) or (No).	Yes

Full UDF Source:

	
	
			
			
			
				
				view plain
				
				
				copy to clipboard
				
				
				
				
				print
				
				
				about
				ColdFISH is developed by Jason Delmore.  Source code and license information available at coldfish.riaforge.org.  Version 3.1.1
				
			<cfscript>
/**
 * Convenience function to set/clear the ReadOnly attribute for the specified file.
 * Uses COM. This is a Windows only funciton. Requires CFOBJECT be enabled in the CF Administrator. This function depends on the SetFileAttribute() function in this library. See the SetFileAttribute() function for details.
 * 
 * @param sFilePath 	 Absolute or relative path to the specified file. 
 * @param bReadOnly 	 Boolean value indicating whether the attribute should be read only (Yes) or  (No). 
 * @return Returns a Boolean value indicating whether the attribute was set. 
 * @author Nate Weiss (&#110;&#97;&#116;&#101;&#64;&#110;&#97;&#116;&#101;&#119;&#101;&#105;&#115;&#115;&#46;&#99;&#111;&#109;) 
 * @version 1, September 27, 2001 
 */
function SetReadOnly(sFilePath, bReadOnly) {
   return setFileAttribute(sFilePath, "ReadOnly", bReadOnly);
 };
</cfscript>
		<cfscript>
/**
 * Convenience function to set/clear the ReadOnly attribute for the specified file.
 * Uses COM. This is a Windows only funciton. Requires CFOBJECT be enabled in the CF Administrator. This function depends on the SetFileAttribute() function in this library. See the SetFileAttribute() function for details.
 * 
 * @param sFilePath      Absolute or relative path to the specified file. 
 * @param bReadOnly      Boolean value indicating whether the attribute should be read only (Yes) or  (No). 
 * @return Returns a Boolean value indicating whether the attribute was set. 
 * @author Nate Weiss (nate@nateweiss.com) 
 * @version 1, September 27, 2001 
 */
function SetReadOnly(sFilePath, bReadOnly) {
   return setFileAttribute(sFilePath, "ReadOnly", bReadOnly);
 };
</cfscript>