mq5.0-source.src.share.cclient.cshim.mqstatus.h Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2000-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* @(#)mqstatus.h 1.15 06/26/07
*/
#ifndef MQ_STATUS_H
#define MQ_STATUS_H
/*
* declarations of C interface for error handling
*/
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
#include "mqtypes.h"
/**
* Returns MQ_TRUE iff status represents an error.
*
* @param status the result of an MQ function call to check
* @return MQ_TRUE iff status represents an error
*/
EXPORTED_SYMBOL MQBool
MQStatusIsError(const MQStatus status);
/**
* Returns the 32 bit error code associated with status.
*
* @param status the result of an MQ function call to check
* @return the 32 bit error code associated with status.
*/
EXPORTED_SYMBOL MQError
MQGetStatusCode(const MQStatus status);
/**
* Returns a string explanation of status. The caller is responsible
* for freeing the returned string by calling MQFreeString.
*
* @param status the result of an MQ function call to check
* @return the string explanation of status */
EXPORTED_SYMBOL MQString
MQGetStatusString(const MQStatus status);
/**
* Gets error trace. The caller is responsible for freeing
* the returned string by calling MQFreeString.
*
* @return the error trace or NULL if no error trace */
EXPORTED_SYMBOL MQString
MQGetErrorTrace();
/**
* Frees a MQString that was returned by MQGetStatusString
* or MQGetErrorTrace
*
* @param string the MQString to free. It must have been
* returned by MQGetStatusString or MQGetErrorTrace */
EXPORTED_SYMBOL void
MQFreeString(MQString string);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* MQ_STATUS_H */