Global Functions in Global Namespace C++
in Sourcefile store.h
- store_acquireHandle
- extern "C"
storeError store_acquireHandle(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Acquire a Handle.
- Parameters
-
- Return
- store_E_None upon success
- store_attrib
- extern "C"
storeError store_attrib(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Set attributes of a file entry.
- Parameters
hFile |
the File Handle.
|
pPath |
the entry path.
|
pName |
the entry name.
|
nMask1 |
the attributes to be cleared.
|
nMask2 |
the attributes to be set.
|
pnAttrib |
the resulting attributes, may be NULL.
|
- Return
- store_E_None upon success
- store_closeDirectory
- extern "C"
storeError store_closeDirectory(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Close a directory.
- Parameters
hDirectory |
the Directory Handle.
|
- Return
- store_E_None upon success,
store_E_InvalidHandle otherwise.
- store_closeFile
- extern "C"
storeError store_closeFile(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Close a file.
- Parameters
-
- Return
- store_E_None upon success,
store_E_InvalidHandle otherwise.
- store_closeStream
- extern "C"
storeError store_closeStream(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Close a stream.
- Parameters
-
- Return
- store_E_None upon success,
store_E_InvalidHandle otherwise.
- store_createMemoryFile
- extern "C"
storeError store_createMemoryFile(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Open a temporary file in memory.
- Parameters
nPageSize |
the creation page size,
integer multiple of minimum page size.
|
phFile |
the File Handle.
|
- Return
- store_E_None upon success
- store_findFirst
- extern "C"
storeError store_findFirst(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Find first directory entry.
- Parameters
hDirectory |
the Directory Handle.
|
pFindData |
the Find Data structure.
|
- Return
- store_E_None upon success,
store_E_NoMoreFile upon end of iteration.
- store_findNext
- extern "C"
storeError store_findNext(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Find next directory entry.
- Parameters
hDirectory |
the Directory Handle.
|
pFindData |
the Find Data structure.
|
- Return
- store_E_None upon success,
store_E_NoMoreFile upon end of iteration.
- store_flushFile
- extern "C"
storeError store_flushFile(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Flush a file.
- Parameters
-
- Return
- store_E_None upon success
- store_flushStream
- extern "C"
storeError store_flushStream(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Flush a stream.
- Parameters
-
- Return
- store_E_None upon success
- store_getFileRefererCount
- extern "C"
storeError store_getFileRefererCount(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Get the number of referers to a file.
- Parameters
hFile |
the File Handle.
|
pnRefCount |
number of open directories and streams.
|
- Return
- store_E_None upon success
- store_getFileSize
- extern "C"
storeError store_getFileSize(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Get the size of a file.
- Parameters
hFile |
the File Handle.
|
pnSize |
the file size in bytes.
|
- Return
- store_E_None upon success
- store_getStreamSize
- extern "C"
storeError store_getStreamSize(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Get the size of a stream.
- Parameters
hStrm |
the Stream Handle.
|
pnSize |
the stream size in bytes.
|
- Return
- store_E_None upon success
- store_link
- extern "C"
storeError store_link(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Insert a file entry as 'hard link' to another file entry.
- Precondition
- Source must not exist, Destination must exist.
- Postcondition
- Source has attribute STORE_ATTRIB_ISLINK.
- See Also
- store_attrib()
- Parameters
hFile |
the File Handle
|
pSrcPath |
the Source path
|
pSrcName |
the Source name
|
pDstPath |
the Destination path
|
pDstName |
the Destination name
|
- Return
- store_E_None upon success
- store_openDirectory
- extern "C"
storeError store_openDirectory(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Open a directory.
- See Also
- store_openFile()
- Parameters
hFile |
the File Handle.
|
pPath |
the directory path.
|
pName |
the directory name.
|
eAccessMode |
the access mode.
|
phDirectory |
the Directory Handle.
|
- Return
- store_E_None upon success
- store_openFile
- extern "C"
storeError store_openFile(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Open a file.
- Parameters
pFilename |
the filename as URL or system path.
|
eAccessMode |
the access mode.
store_AccessCreate truncate existing and create,
store_AccessReadCreate create not existing,
store_AccessReadWrite write existing,
store_AccessReadOnly never modifies.
|
nPageSize |
the creation page size,
integer multiple of minimum page size.
|
phFile |
the File Handle.
|
- Return
- store_E_None upon success
- store_openStream
- extern "C"
storeError store_openStream(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Open a stream.
- See Also
- store_openFile()
- Parameters
hFile |
the File Handle.
|
pPath |
the stream path.
|
pName |
the stream name.
|
eAccessMode |
the access mode.
|
phStrm |
the Stream Handle.
|
- Return
- store_E_None upon success
- store_readStream
- extern "C"
storeError store_readStream(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Read from a stream.
- Parameters
hStrm |
the Stream Handle.
|
nOffset |
the offset of the first byte to read.
|
pBuffer |
the buffer.
|
nBytes |
the number of bytes to read.
|
pnDone |
the number of bytes actually read.
|
- Return
- store_E_None upon success
- store_rebuildFile
- extern "C"
storeError store_rebuildFile(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Recover and Compact a file into another file.
- See Also
- store_openFile()
- Parameters
pSrcFilename |
opened with store_AccessReadOnly.
|
pDstFilename |
created with store_AccessCreate.
|
- Return
- store_E_None upon success
- store_releaseHandle
- extern "C"
storeError store_releaseHandle(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Release a Handle.
- Parameters
-
- Return
- store_E_None upon success,
store_E_InvalidHandle otherwise.
- store_remove
- extern "C"
storeError store_remove(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Remove a file entry.
- Parameters
hFile |
the File Handle
|
pPath |
the entry path
|
pName |
the entry name
|
- Return
- store_E_None upon success
- store_rename
- extern "C"
storeError store_rename(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Rename a file entry.
- Parameters
hFile |
the File Handle
|
pSrcPath |
the Source path
|
pSrcName |
the Source name
|
pDstPath |
the Destination path
|
pDstName |
the Destination name
|
- Return
- store_E_None upon success
- store_setStreamSize
- extern "C"
storeError store_setStreamSize(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Set the size of a stream.
- Parameters
hStrm |
the Stream Handle.
|
nSize |
the new stream size in bytes.
|
- Return
- store_E_None upon success
- store_symlink
- extern "C"
storeError store_symlink(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Insert a file entry as 'symbolic link' to another file entry.
- Precondition
- Source must not exist
- Postcondition
- Source has attribute STORE_ATTRIB_ISLINK.
- See Also
- store_attrib()
- Parameters
hFile |
the File Handle
|
pSrcPath |
the Source path
|
pSrcName |
the Source name
|
pDstPath |
the Destination path
|
pDstName |
the Destination name
|
- Return
- store_E_None upon success
- store_writeStream
- extern "C"
storeError store_writeStream(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Write to a stream.
- Parameters
hStrm |
the Stream Handle.
|
nOffset |
the offset of the first byte to write.
|
pBuffer |
the buffer.
|
nBytes |
the number of bytes to write.
|
pnDone |
the number of bytes actually written.
|
- Return
- store_E_None upon success
Top of Page
Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.