sdbwrite.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PDB WINAPI	SdbCreateDatabase (LPCWSTR path, PATH_TYPE type)
void WINAPI	SdbCloseDatabaseWrite (PDB db)
BOOL WINAPI	SdbWriteNULLTag (PDB db, TAG tag)
BOOL WINAPI	SdbWriteWORDTag (PDB db, TAG tag, WORD data)
BOOL WINAPI	SdbWriteDWORDTag (PDB db, TAG tag, DWORD data)
BOOL WINAPI	SdbWriteQWORDTag (PDB db, TAG tag, QWORD data)
BOOL WINAPI	SdbWriteStringTag (PDB db, TAG tag, LPCWSTR string)
BOOL WINAPI	SdbWriteStringRefTag (PDB db, TAG tag, TAGID tagid)
BOOL WINAPI	SdbWriteBinaryTag (PDB db, TAG tag, const BYTE *data, DWORD size)
BOOL WINAPI	SdbWriteBinaryTagFromFile (PDB db, TAG tag, LPCWSTR path)
TAGID WINAPI	SdbBeginWriteListTag (PDB db, TAG tag)
BOOL WINAPI	SdbEndWriteListTag (PDB db, TAGID tagid)

Function Documentation

SdbBeginWriteListTag()

TAGID WINAPI SdbBeginWriteListTag	(	PDB	pdb,
		TAG	tag
	)

Writes a list tag to specified database All subsequent SdbWrite* functions shall write to newly created list untill TAGID of that list is passed to SdbEndWriteListTag.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	TAG for the list RETURNS Success: TAGID of the newly created list, or TAGID_NULL on failure.

Returns

A TAGID.

Definition at line 321 of file sdbwrite.c.

{
    TAGID list_id;
    DWORD dum = 0;
 
    if (!SdbpCheckTagType(tag, TAG_TYPE_LIST))
        return TAGID_NULL;
 
    list_id = pdb->write_iter;
    SdbpWrite(pdb, &tag, sizeof(TAG));
    SdbpWrite(pdb, &dum, sizeof(dum)); /* reserve some memory for storing list size */
    return list_id;
}

Referenced by Database::BeginWriteListTag(), and SdbpWriteStringtable().

SdbCloseDatabaseWrite()

void WINAPI SdbCloseDatabaseWrite

(

PDB

pdb

)

Closes specified database and writes data to file.

Parameters

[in]

pdb

Handle to the shim database.

Definition at line 129 of file sdbwrite.c.

{
    ASSERT(pdb->for_write);
    SdbpWriteStringtable(pdb);
    SdbpFlush(pdb);
    SdbCloseDatabase(pdb);
}

Referenced by Database::toSdb().

SdbCreateDatabase()

PDB WINAPI SdbCreateDatabase	(	LPCWSTR	path,
		PATH_TYPE	type
	)

Creates new shim database file

If a file already exists on specified path, that file shall be overwritten.

Note

Use SdbCloseDatabaseWrite to close the database opened with this function.

Parameters

[in]	path	Path to the new shim database.
[in]	type	Type of path. Either DOS_PATH or NT_PATH.

Returns

Success: Handle to the newly created shim database, NULL otherwise.

Definition at line 104 of file sdbwrite.c.

{
    static const DWORD version_major = 2, version_minor = 1;
    static const char* magic = "sdbf";
    PDB pdb;
 
    pdb = SdbpCreate(path, type, TRUE);
    if (!pdb)
        return NULL;
 
    pdb->size = sizeof(DWORD) + sizeof(DWORD) + (DWORD)strlen(magic);
    pdb->data = SdbAlloc(pdb->size);
 
    SdbpWrite(pdb, &version_major, sizeof(DWORD));
    SdbpWrite(pdb, &version_minor, sizeof(DWORD));
    SdbpWrite(pdb, magic, (DWORD)strlen(magic));
 
    return pdb;
}

Referenced by Database::toSdb().

SdbEndWriteListTag()

BOOL WINAPI SdbEndWriteListTag	(	PDB	pdb,
		TAGID	tagid
	)

Marks end of the specified list.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tagid	TAGID of the list.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 343 of file sdbwrite.c.

{
    ASSERT(pdb->for_write);
 
    if (!SdbpCheckTagIDType(pdb, tagid, TAG_TYPE_LIST))
        return FALSE;
 
    /* Write size of list to list tag header */
    *(DWORD*)&pdb->data[tagid + sizeof(TAG)] = pdb->write_iter - tagid - sizeof(TAG) - sizeof(TAGID);
    return TRUE;
}

Referenced by Database::EndWriteListTag(), and SdbpWriteStringtable().

SdbWriteBinaryTag()

BOOL WINAPI SdbWriteBinaryTag	(	PDB	pdb,
		TAG	tag,
		const BYTE *	data,
		DWORD	size
	)

Writes data the specified shim database.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	A tag for the entry.
[in]	data	Pointer to data.
[in]	size	Number of bytes to write.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 273 of file sdbwrite.c.

{
    if (!SdbpCheckTagType(tag, TAG_TYPE_BINARY))
        return FALSE;
 
    SdbpWrite(pdb, &tag, sizeof(TAG));
    SdbpWrite(pdb, &size, sizeof(size));
    SdbpWrite(pdb, data, size);
    return TRUE;
}

Referenced by SdbWriteBinaryTagFromFile(), and Database::WriteBinary().

SdbWriteBinaryTagFromFile()

BOOL WINAPI SdbWriteBinaryTagFromFile	(	PDB	pdb,
		TAG	tag,
		LPCWSTR	path
	)

Writes data from a file to the specified shim database.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	A tag for the entry.
[in]	path	Path of the input file.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 294 of file sdbwrite.c.

{
    MEMMAPPED mapped;
 
    if (!SdbpCheckTagType(tag, TAG_TYPE_BINARY))
        return FALSE;
 
    if (!SdbpOpenMemMappedFile(path, &mapped))
        return FALSE;
 
    SdbWriteBinaryTag(pdb, tag, mapped.view, mapped.size);
    SdbpCloseMemMappedFile(&mapped);
    return TRUE;
}

SdbWriteDWORDTag()

BOOL WINAPI SdbWriteDWORDTag	(	PDB	pdb,
		TAG	tag,
		DWORD	data
	)

Writes a DWORD entry to the specified shim database.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	A tag for the entry.
[in]	data	DWORD entry which will be written to the database.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 182 of file sdbwrite.c.

{
    if (!SdbpCheckTagType(tag, TAG_TYPE_DWORD))
        return FALSE;
 
    SdbpWrite(pdb, &tag, sizeof(TAG));
    SdbpWrite(pdb, &data, sizeof(data));
    return TRUE;
}

Referenced by Database::toSdb(), ShimRef::toSdb(), FlagRef::toSdb(), and Database::WriteDWord().

SdbWriteNULLTag()

BOOL WINAPI SdbWriteNULLTag	(	PDB	pdb,
		TAG	tag
	)

Writes a tag-only (NULL) entry to the specified shim database.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	A tag for the entry.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 145 of file sdbwrite.c.

{
    if (!SdbpCheckTagType(tag, TAG_TYPE_NULL))
        return FALSE;
 
    SdbpWrite(pdb, &tag, sizeof(TAG));
    return TRUE;
}

Referenced by InExclude::toSdb().

SdbWriteQWORDTag()

BOOL WINAPI SdbWriteQWORDTag	(	PDB	pdb,
		TAG	tag,
		QWORD	data
	)

Writes a DWORD entry to the specified shim database.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	A tag for the entry.
[in]	data	QWORD entry which will be written to the database.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 201 of file sdbwrite.c.

{
    if (!SdbpCheckTagType(tag, TAG_TYPE_QWORD))
        return FALSE;
 
    SdbpWrite(pdb, &tag, sizeof(TAG));
    SdbpWrite(pdb, &data, sizeof(data));
    return TRUE;
}

Referenced by Database::toSdb(), and Database::WriteQWord().

SdbWriteStringRefTag()

BOOL WINAPI SdbWriteStringRefTag	(	PDB	pdb,
		TAG	tag,
		TAGID	tagid
	)

Writes a stringref tag to specified database

Note

Reference (tagid) is not checked for validity.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	TAG which will be written.
[in]	tagid	TAGID of the string tag refers to.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 253 of file sdbwrite.c.

{
    if (!SdbpCheckTagType(tag, TAG_TYPE_STRINGREF))
        return FALSE;
 
    SdbpWrite(pdb, &tag, sizeof(TAG));
    SdbpWrite(pdb, &tagid, sizeof(tagid));
    return TRUE;
}

Referenced by SdbWriteStringTag().

SdbWriteStringTag()

BOOL WINAPI SdbWriteStringTag	(	PDB	pdb,
		TAG	tag,
		LPCWSTR	string
	)

Writes a wide string entry to the specified shim database.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	A tag for the entry.
[in]	string	Wide string entry which will be written to the database.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 220 of file sdbwrite.c.

{
    DWORD size;
 
    if (SdbpCheckTagType(tag, TAG_TYPE_STRINGREF))
    {
        TAGID tagid = 0;
        if (!SdbpGetOrAddStringRef(pdb, string, &tagid))
            return FALSE;
 
        return SdbWriteStringRefTag(pdb, tag, tagid);
    }
 
    if (!SdbpCheckTagType(tag, TAG_TYPE_STRING))
        return FALSE;
 
    size = SdbpStrsize(string);
    SdbpWrite(pdb, &tag, sizeof(TAG));
    SdbpWrite(pdb, &size, sizeof(size));
    SdbpWrite(pdb, string, size);
    return TRUE;
}

Referenced by SdbpGetOrAddStringRef(), and Database::WriteString().

SdbWriteWORDTag()

BOOL WINAPI SdbWriteWORDTag	(	PDB	pdb,
		TAG	tag,
		WORD	data
	)

Writes a WORD entry to the specified shim database.

Parameters

[in]	pdb	Handle to the shim database.
[in]	tag	A tag for the entry.
[in]	data	WORD entry which will be written to the database.

Returns

TRUE if it succeeds, FALSE if it fails.

Definition at line 163 of file sdbwrite.c.

{
    if (!SdbpCheckTagType(tag, TAG_TYPE_WORD))
        return FALSE;
 
    SdbpWrite(pdb, &tag, sizeof(TAG));
    SdbpWrite(pdb, &data, sizeof(data));
    return TRUE;
}