_Internal.h

Go to the documentation of this file.

// Project: uLib
// Module: A handful of small internal subroutines used by various implementation modules.
//
// Note: These function id's have two leading underscores to mark them as global internals.
// That is, routines that regular uLib users have no need to concern themselves with.
// Parameter validation is generally absent. It is assumed callers constrain their arguments.
// Alas, anyone may of course use them if they fit the bill.
// For usage examples, see e.g. ReparsePnt.cpp
//
// Author: Love Nystrom

#ifndef __uLib_Internal_h_incl__
#define __uLib_Internal_h_incl__

#include <uLib/Common.h>

BEGIN_EXTERN_C

#define FILE_WRITE_ATTRIB_EA  (FILE_WRITE_ATTRIBUTES| FILE_WRITE_EA)
#define FILE_READ_ATTRIB_EA   (FILE_READ_ATTRIBUTES| FILE_READ_EA)

// Return the passed-in boolean expression, and, if FALSE, set an error code.
// Ex: ok = __ChkOkSetErr( !DirExist( LinkName ), ERROR_FILE_EXISTS );

__inline bool __ChkOkSetErr( BOOL Ok, DWORD Err )
{
    if (!Ok) SetLastError( Err );
    return bool_cast( Ok );
}

// Return the passed-in boolean expression, and, if FALSE, get an error code. 
// Ex: ok = __ChkOkGetErr( CreateDirectory( LinkName, NULL ), &error );

__inline bool __ChkOkGetErr( BOOL Ok, PDWORD pErr )
{
    if (!Ok) *pErr = GetLastError();
    return bool_cast( Ok );
}

// Enable a privilege for the current process. Return the token handle and previous state.

bool __EnableProcPrivilege( IN CSTR Privilege, OUT LUID_AND_ATTRIBUTES* pPrv, OUT HANDLE* pToken );

// Get the root component of PathName.
// Handles both DOS paths and UNC paths (\\server\share\path).

bool __GetRoot( OUT TSTR Root, UINT ccRoot, IN CSTR PathName );

// Get the file system ability flags of PathName's containing volume.

DWORD __GetVolumeFlags( CSTR PathName );

// Get the S/N of PathName's containing volume.

DWORD __GetVolumeId( CSTR PathName );

// Get the S/N of the volume of an open FS object.

DWORD __GetHandleVolumeId( HANDLE hObj );

// Change the CWD to that of PathName's path component.

CSTR __ChangeToDirOf( CSTR PathName );

END_EXTERN_C
#endif//ndef __uLib_Internal_h_incl__
// EOF