wave-windows.cpp

Go to the documentation of this file.

/*
 * wave-windows.cpp
 *
 * Copyright (C) 2010  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Helpful functions for Windows APIs.  See wave-windows.h
 */

// includes --------------------------------------------------------------------
#include "wave-windows.h"               // always include our own header first!




////////////////////////////////////////////////////////////////////////////////
//
//      static helper methods
//
////////////////////////////////////////////////////////////////////////////////


////////////////////////////////////////////////////////////////////////////////
//
//      public API
//
////////////////////////////////////////////////////////////////////////////////

#define RPC_VALUE(token) case token : DPRINTF("   ...%s", #token );


void
checkRpcStatus
(
IN RPC_STATUS rpc
)
{
        DPRINTF("Checking Windows RPC status code 0x%08x = %ld ...", rpc, rpc);

        switch (rpc) {
        RPC_VALUE(RPC_S_OK)
        default:
                DPRINTF("  ...unrecognized RPC status code!");
        }
}


#define HR_VALUE(token) case token : DPRINTF("  ...%s", #token ); break;

void
checkHresult
(
IN HRESULT hr
)
{
        DPRINTF("Checking Windows HRESULT code 0x%08x = %ld...", hr, hr);

        switch (hr) {
        HR_VALUE(E_ACCESSDENIED)
        HR_VALUE(E_HANDLE)
        HR_VALUE(E_POINTER)
        HR_VALUE(S_FALSE)
        HR_VALUE(S_OK)
        default:
                DPRINTF("  ...unrecognzed HRESULT code!");
        }
}



void
writeGuid
(
IO std::ostream& stream,
IN const GUID& guid
)
{
        const int bufsize = 64;
        char buffer[bufsize];
        stream << getGuidString(guid, buffer, bufsize);
}


const char *
getGuidString
(
IN const GUID& guid,
IO char * buffer,
IN int bufsize
)
{
        ASSERT(buffer, "null");
        ASSERT(bufsize > 0, "bad buffer size: %d", bufsize);

        unsigned char * value = NULL;
        RPC_STATUS retval = UuidToString(&guid, &value);
        RPC_VERIFY(RPC_S_OK == retval && value, retval,
            "Failed to call UuidToString()");
        // DPRINTF("value = '%s'", value);
        strncpy(buffer, (const char *) value, bufsize);
        retval = RpcStringFree(&value);
        RPC_VERIFY(RPC_S_OK == retval, retval,
            "Failed to free RPC string after UuidToString call");

        // return string as a convenience
        return buffer;
}