/core/externals/update-engine/externals/google-toolbox-for-mac/Foundation/GTMNSString+FindFolder.h

 1//
 2//  GTMNSString+FindFolder.h
 3//
 4//  Copyright 2006-2008 Google Inc.
 5//
 6//  Licensed under the Apache License, Version 2.0 (the "License"); you may not
 7//  use this file except in compliance with the License.  You may obtain a copy
 8//  of the License at
 9// 
10//  http://www.apache.org/licenses/LICENSE-2.0
11// 
12//  Unless required by applicable law or agreed to in writing, software
13//  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14//  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
15//  License for the specific language governing permissions and limitations under
16//  the License.
17//
18
19#import <Foundation/Foundation.h>
20
21@interface NSString (GTMStringFindFolderAdditions)
22
23// Create a path to a folder located with FindFolder
24//
25// Args:
26//   theFolderType: one of the folder types in Folders.h 
27//                  (kPreferencesFolderType, etc)
28//   theDomain: one of the domains in Folders.h (kLocalDomain, kUserDomain, etc)
29//   doCreate: create the folder if it does not already exist
30//
31// Returns:
32//   full path to folder, or nil if the folder doesn't exist or can't be created
33//
34+ (NSString *)gtm_stringWithPathForFolder:(OSType)theFolderType 
35                                 inDomain:(short)theDomain 
36                                 doCreate:(BOOL)doCreate;
37
38// Create a path to a folder inside a folder located with FindFolder
39//
40// Args:
41//   theFolderType: one of the folder types in Folders.h 
42//                  (kPreferencesFolderType, etc)
43//   subfolderName: name of directory inside the Apple folder to be located or created
44//   theDomain: one of the domains in Folders.h (kLocalDomain, kUserDomain, etc)
45//   doCreate: create the folder if it does not already exist
46//
47// Returns:
48//   full path to subdirectory, or nil if the folder doesn't exist or can't be created
49//
50+ (NSString *)gtm_stringWithPathForFolder:(OSType)theFolderType 
51                            subfolderName:(NSString *)subfolderName
52                                 inDomain:(short)theDomain
53                                 doCreate:(BOOL)doCreate;  
54
55@end