stringapiset.h

/******************************************************************************** * * * stringapi.h -- ApiSet Contract for api-ms-win-core-string-l1 * * * * Copyright (c) Microsoft Corporation. All rights reserved. * * * ********************************************************************************/

#ifdef _MSC_VER

#pragma once

#endif // _MSC_VER

#ifndef _APISETSTRING_

#define _APISETSTRING_

#include <apiset.h>

#include <apisetcconv.h>

#include <minwindef.h> #include <winnls.h>

#ifdef __cplusplus

extern

"C"

{

#endif

#if (WINVER >= 0x0600)

#pragma region Application or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI

__declspec

(dllimport)

int

WINAPI

__stdcall

CompareStringEx

(

_In_opt_ LPCWSTR lpLocaleName,

LPCWSTR

lpLocaleName

_In_ DWORD dwCmpFlags,

DWORD

dwCmpFlags

_In_NLS_string_(cchCount1) LPCWCH lpString1,

LPCWCH

lpString1

_In_ int cchCount1,

int

cchCount1

_In_NLS_string_(cchCount2) LPCWCH lpString2,

LPCWCH

lpString2

_In_ int cchCount2,

int

cchCount2

_Reserved_ LPNLSVERSIONINFO lpVersionInformation,

LPNLSVERSIONINFO

lpVersionInformation

_Reserved_ LPVOID lpReserved,

LPVOID

lpReserved

_Reserved_ LPARAM lParam

LPARAM

lParam

);

WINBASEAPI

__declspec

(dllimport)

int

WINAPI

__stdcall

CompareStringOrdinal

(

_In_NLS_string_(cchCount1) LPCWCH lpString1,

LPCWCH

lpString1

_In_ int cchCount1,

int

cchCount1

_In_NLS_string_(cchCount2) LPCWCH lpString2,

LPCWCH

lpString2

_In_ int cchCount2,

int

cchCount2

_In_ BOOL bIgnoreCase

BOOL

bIgnoreCase

);

#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */

#pragma endregion

#endif //(WINVER >= 0x0600)

#pragma region Desktop or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI

__declspec

(dllimport)

int

WINAPI

__stdcall

CompareStringW

(

_In_ LCID Locale,

LCID

Locale

_In_ DWORD dwCmpFlags,

DWORD

dwCmpFlags

_In_NLS_string_(cchCount1) PCNZWCH lpString1,

PCNZWCH

lpString1

_In_ int cchCount1,

int

cchCount1

_In_NLS_string_(cchCount2) PCNZWCH lpString2,

PCNZWCH

lpString2

_In_ int cchCount2

int

cchCount2

);

#ifdef UNICODE

#define CompareString CompareStringW #endif

WINBASEAPI

__declspec

(dllimport)

int

WINAPI

__stdcall

FoldStringW

(

_In_ DWORD dwMapFlags,

DWORD

dwMapFlags

_In_NLS_string_(cchSrc) LPCWCH lpSrcStr,

LPCWCH

lpSrcStr

_In_ int cchSrc,

int

cchSrc

_Out_writes_opt_(cchDest) LPWSTR lpDestStr,

LPWSTR

lpDestStr

_In_ int cchDest

int

cchDest

);

#ifdef UNICODE

#define FoldString FoldStringW #endif

#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM) */

#pragma endregion #pragma region Application or OneCore Family

#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM)

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

GetStringTypeExW

(

_In_ LCID Locale,

LCID

Locale

_In_ DWORD dwInfoType,

DWORD

dwInfoType

_In_NLS_string_(cchSrc) LPCWCH lpSrcStr,

LPCWCH

lpSrcStr

_In_ int cchSrc,

int

cchSrc

_Out_writes_(cchSrc) LPWORD lpCharType

LPWORD

lpCharType

);

#ifdef UNICODE

#define GetStringTypeEx GetStringTypeExW #endif

WINBASEAPI

__declspec

(dllimport)

BOOL

WINAPI

__stdcall

GetStringTypeW

(

_In_ DWORD dwInfoType,

DWORD

dwInfoType

_In_NLS_string_(cchSrc) LPCWCH lpSrcStr,

LPCWCH

lpSrcStr

_In_ int cchSrc,

int

cchSrc

_Out_ LPWORD lpCharType

LPWORD

lpCharType

);

// NLS Code Page Dependent APIs.

WINBASEAPI

__declspec

(dllimport)

_Success_(return != 0)

_When_((cbMultiByte == -1) && (cchWideChar != 0), _Post_equal_to_(_String_length_(lpWideCharStr)+1))

int

WINAPI

__stdcall

MultiByteToWideChar

(

_In_ UINT CodePage,

UINT

CodePage

_In_ DWORD dwFlags,

DWORD

dwFlags

_In_NLS_string_(cbMultiByte) LPCCH lpMultiByteStr,

LPCCH

lpMultiByteStr

_In_ int cbMultiByte,

int

cbMultiByte

_Out_writes_to_opt_(cchWideChar,return) LPWSTR lpWideCharStr,

LPWSTR

lpWideCharStr

_In_ int cchWideChar

int

cchWideChar

);

WINBASEAPI

__declspec

(dllimport)

_Success_(return != 0)

_When_((cchWideChar == -1) && (cbMultiByte != 0), _Post_equal_to_(_String_length_(lpMultiByteStr)+1))

int

WINAPI

__stdcall

WideCharToMultiByte

(

_In_ UINT CodePage,

UINT

CodePage

_In_ DWORD dwFlags,

DWORD

dwFlags

_In_NLS_string_(cchWideChar) LPCWCH lpWideCharStr,

LPCWCH

lpWideCharStr

_In_ int cchWideChar,

int

cchWideChar

_Out_writes_bytes_to_opt_(cbMultiByte,return) LPSTR lpMultiByteStr,

LPSTR

lpMultiByteStr

_In_ int cbMultiByte,

int

cbMultiByte

_In_opt_ LPCCH lpDefaultChar,

LPCCH

lpDefaultChar

_Out_opt_ LPBOOL lpUsedDefaultChar

LPBOOL

lpUsedDefaultChar

);

#endif /* WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP | WINAPI_PARTITION_SYSTEM) */

#pragma endregion

#ifdef __cplusplus

}

#endif

#endif // _APISETSTRING_