| 1 | /* $Id: file.h 98103 2023-01-17 14:15:46Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Internal RTFile header.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * The contents of this file may alternatively be used under the terms
|
|---|
| 26 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 28 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 29 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 30 | *
|
|---|
| 31 | * You may elect to license modified versions of this file under the
|
|---|
| 32 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 33 | *
|
|---|
| 34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 | #ifndef IPRT_INCLUDED_INTERNAL_file_h
|
|---|
| 38 | #define IPRT_INCLUDED_INTERNAL_file_h
|
|---|
| 39 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 40 | # pragma once
|
|---|
| 41 | #endif
|
|---|
| 42 |
|
|---|
| 43 | #include <iprt/file.h>
|
|---|
| 44 |
|
|---|
| 45 | RT_C_DECLS_BEGIN
|
|---|
| 46 |
|
|---|
| 47 | /**
|
|---|
| 48 | * Adjusts and validates the flags.
|
|---|
| 49 | *
|
|---|
| 50 | * The adjustments are made according to the wishes specified using the RTFileSetForceFlags API.
|
|---|
| 51 | *
|
|---|
| 52 | * @returns IPRT status code.
|
|---|
| 53 | * @param pfOpen Pointer to the user specified flags on input.
|
|---|
| 54 | * Updated on successful return.
|
|---|
| 55 | * @internal
|
|---|
| 56 | */
|
|---|
| 57 | int rtFileRecalcAndValidateFlags(uint64_t *pfOpen);
|
|---|
| 58 |
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * Internal interface for getting the RTFILE handle of stdin, stdout or stderr.
|
|---|
| 62 | *
|
|---|
| 63 | * This interface will not be exposed and is purely for internal IPRT use.
|
|---|
| 64 | *
|
|---|
| 65 | * @returns Handle or NIL_RTFILE.
|
|---|
| 66 | *
|
|---|
| 67 | * @param enmStdHandle The standard handle.
|
|---|
| 68 | */
|
|---|
| 69 | RTFILE rtFileGetStandard(RTHANDLESTD enmStdHandle);
|
|---|
| 70 |
|
|---|
| 71 | #ifdef RT_OS_WINDOWS
|
|---|
| 72 | /**
|
|---|
| 73 | * Helper for converting RTFILE_O_XXX to the various NtCreateFile flags.
|
|---|
| 74 | *
|
|---|
| 75 | * @returns IPRT status code
|
|---|
| 76 | * @param fOpen The RTFILE_O_XXX flags to convert.
|
|---|
| 77 | * @param pfDesiredAccess Where to return the desired access mask.
|
|---|
| 78 | * @param pfObjAttribs Where to return the NT object attributes.
|
|---|
| 79 | * @param pfFileAttribs Where to return the file attributes (create).
|
|---|
| 80 | * @param pfShareAccess Where to return the file sharing access mask.
|
|---|
| 81 | * @param pfCreateDisposition Where to return the file create disposition.
|
|---|
| 82 | * @param pfCreateOptions Where to return the file open/create options.
|
|---|
| 83 | */
|
|---|
| 84 | DECLHIDDEN(int) rtFileNtValidateAndConvertFlags(uint64_t fOpen, uint32_t *pfDesiredAccess, uint32_t *pfObjAttribs,
|
|---|
| 85 | uint32_t *pfFileAttribs, uint32_t *pfShareAccess, uint32_t *pfCreateDisposition,
|
|---|
| 86 | uint32_t *pfCreateOptions);
|
|---|
| 87 |
|
|---|
| 88 | #endif
|
|---|
| 89 |
|
|---|
| 90 | RT_C_DECLS_END
|
|---|
| 91 |
|
|---|
| 92 | #endif /* !IPRT_INCLUDED_INTERNAL_file_h */
|
|---|
| 93 |
|
|---|
