You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

106 lines
3.7 KiB

// Copyright Epic Games, Inc. All Rights Reserved.
// This file is automatically generated. Changes to this file may be overwritten.
namespace Epic.OnlineServices
{
public sealed partial class Common
{
/// <summary>
/// An invalid notification ID
/// </summary>
public const ulong InvalidNotificationid = ((ulong)0);
/// <summary>
/// A macro to identify an unknown integrated platform.
/// </summary>
public static readonly Utf8String IptUnknown = (string)null;
/// <summary>
/// The most recent version of the <see cref="PageQuery" /> structs.
/// </summary>
public const int PagequeryApiLatest = 1;
/// <summary>
/// The default MaxCount used for a <see cref="PageQuery" /> when the API allows the <see cref="PageQuery" /> to be omitted.
/// </summary>
public const int PagequeryMaxcountDefault = 10;
/// <summary>
/// The maximum MaxCount used for a <see cref="PageQuery" />.
/// </summary>
public const int PagequeryMaxcountMaximum = 100;
/// <summary>
/// DEPRECATED! Use <see cref="PagequeryApiLatest" /> instead.
/// </summary>
public const int PaginationApiLatest = PagequeryApiLatest;
/// <summary>
/// Returns whether a result is to be considered the final result, or false if the callback that returned this result
/// will be called again either after some time or from another action.
/// </summary>
/// <param name="result">The result to check against being a final result for an operation</param>
/// <returns>
/// True if this result means the operation is complete, false otherwise
/// </returns>
public static bool IsOperationComplete(Result result)
{
var funcResult = Bindings.EOS_EResult_IsOperationComplete(result);
bool funcResultReturn;
Helper.Get(funcResult, out funcResultReturn);
return funcResultReturn;
}
/// <summary>
/// Returns a string representation of an <see cref="Result" />.
/// The return value is never null.
/// The return value must not be freed.
///
/// Example: <see cref="ToString" />(<see cref="Result.Success" />) returns "EOS_Success"
/// </summary>
public static Utf8String ToString(Result result)
{
var funcResult = Bindings.EOS_EResult_ToString(result);
Utf8String funcResultReturn;
Helper.Get(funcResult, out funcResultReturn);
return funcResultReturn;
}
/// <summary>
/// Encode a byte array into hex encoded string
/// </summary>
/// <returns>
/// An <see cref="Result" /> that indicates whether the byte array was converted and copied into the OutBuffer.
/// <see cref="Result.Success" /> if the encoding was successful and passed out in OutBuffer
/// <see cref="Result.InvalidParameters" /> if you pass a null pointer on invalid length for any of the parameters
/// <see cref="Result.LimitExceeded" /> - The OutBuffer is not large enough to receive the encoding. InOutBufferLength contains the required minimum length to perform the operation successfully.
/// </returns>
public static Result ToString(System.ArraySegment<byte> byteArray, out Utf8String outBuffer)
{
var byteArrayAddress = System.IntPtr.Zero;
uint length;
Helper.Set(byteArray, ref byteArrayAddress, out length);
uint inOutBufferLength = 1024;
System.IntPtr outBufferAddress = Helper.AddAllocation(inOutBufferLength);
var funcResult = Bindings.EOS_ByteArray_ToString(byteArrayAddress, length, outBufferAddress, ref inOutBufferLength);
Helper.Dispose(ref byteArrayAddress);
Helper.Get(outBufferAddress, out outBuffer);
Helper.Dispose(ref outBufferAddress);
return funcResult;
}
public static Utf8String ToString(System.ArraySegment<byte> byteArray)
{
Utf8String funcResult;
ToString(byteArray, out funcResult);
return funcResult;
}
}
}