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