mirror of https://github.com/dahall/Vanara.git
Updated documentation
parent
5597d959c2
commit
3a56122887
|
@ -27,7 +27,7 @@ namespace Vanara.PInvoke
|
||||||
|
|
||||||
/// <summary>Gets a size and returns an error.</summary>
|
/// <summary>Gets a size and returns an error.</summary>
|
||||||
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
|
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
|
||||||
/// <param name="sz">On input, the size of the <paramref name="sb"/> capacity. On output, the number of characters written.</param>
|
/// <param name="sz">On input, the size of the capacity. On output, the number of characters written.</param>
|
||||||
/// <returns>Resulting error or <see cref="Win32Error.ERROR_SUCCESS"/> on success.</returns>
|
/// <returns>Resulting error or <see cref="Win32Error.ERROR_SUCCESS"/> on success.</returns>
|
||||||
public delegate Win32Error SizeFunc<TSize>(ref TSize sz) where TSize : struct, IConvertible;
|
public delegate Win32Error SizeFunc<TSize>(ref TSize sz) where TSize : struct, IConvertible;
|
||||||
|
|
||||||
|
@ -41,7 +41,7 @@ namespace Vanara.PInvoke
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
|
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
|
||||||
/// <typeparam name="TRet">The error provider return type.</typeparam>
|
/// <typeparam name="TRet">The error provider return type.</typeparam>
|
||||||
/// <param name="sz">On input, the size of the <paramref name="sb"/> capacity. On ouput, the number of characters written.</param>
|
/// <param name="sz">On input, the size of the capacity. On output, the number of characters written.</param>
|
||||||
/// <param name="err">The error.</param>
|
/// <param name="err">The error.</param>
|
||||||
/// <returns><c>true</c> if buffer size is good; otherwise <c>false</c>.</returns>
|
/// <returns><c>true</c> if buffer size is good; otherwise <c>false</c>.</returns>
|
||||||
public static bool ChkGoodBuf<TSize, TRet>(TSize sz, TRet err) where TSize : struct where TRet : IErrorProvider, IConvertible => !sz.Equals(default(TSize)) && (err.ToHRESULT() == (HRESULT)(Win32Error)Win32Error.ERROR_MORE_DATA || err.ToHRESULT() == (HRESULT)(Win32Error)Win32Error.ERROR_INSUFFICIENT_BUFFER);
|
public static bool ChkGoodBuf<TSize, TRet>(TSize sz, TRet err) where TSize : struct where TRet : IErrorProvider, IConvertible => !sz.Equals(default(TSize)) && (err.ToHRESULT() == (HRESULT)(Win32Error)Win32Error.ERROR_MORE_DATA || err.ToHRESULT() == (HRESULT)(Win32Error)Win32Error.ERROR_INSUFFICIENT_BUFFER);
|
||||||
|
|
|
@ -49,8 +49,8 @@ namespace Vanara.InteropServices
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>Gets or sets the <see cref="TElem"/> at the specified index.</summary>
|
/// <summary>Gets or sets the <typeparamref name="TElem"/> value at the specified index.</summary>
|
||||||
/// <value>The <see cref="TElem"/>.</value>
|
/// <value>The <typeparamref name="TElem"/> value.</value>
|
||||||
/// <param name="index">The index.</param>
|
/// <param name="index">The index.</param>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
/// <exception cref="ArgumentOutOfRangeException">index or index</exception>
|
/// <exception cref="ArgumentOutOfRangeException">index or index</exception>
|
||||||
|
|
Loading…
Reference in New Issue