OemToCharBuff function

Translates a specified number of characters in a string from the OEM-defined character set into either an ANSI or a wide-character string.

Syntax


BOOL WINAPI OemToCharBuff(
  _In_   LPCSTR lpszSrc,
  _Out_  LPTSTR lpszDst,
  _In_   DWORD cchDstLength
);

Parameters

lpszSrc [in]

Type: LPCSTR

One or more characters from the OEM-defined character set.

lpszDst [out]

Type: LPTSTR

The destination buffer, which receives the translated string. If the OemToCharBuff function is being used as an ANSI function, the string can be translated in place by setting the lpszDst parameter to the same address as the lpszSrc parameter. This cannot be done if the OemToCharBuff function is being used as a wide-character function.

cchDstLength [in]

Type: DWORD

The number of characters to be translated in the buffer identified by the lpszSrc parameter.

Return value

Type: BOOL

The return value is always nonzero except when you pass the same address to lpszSrc and lpszDst in the wide-character version of the function. In this case the function returns zero and GetLastError returns ERROR_INVALID_ADDRESS.

Remarks

Unlike the OemToChar function, the OemToCharBuff function does not stop converting characters when it encounters a null character in the buffer pointed to by lpszSrc. The OemToCharBuff function converts all cchDstLength characters.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

Unicode and ANSI names

OemToCharBuffW (Unicode) and OemToCharBuffA (ANSI)

See also

Reference
CharToOem
CharToOemBuff
OemToChar
Conceptual
Strings

 

 

Community Additions

ADD
Show:
© 2014 Microsoft