Share via


MimeOleEscapeString function

Do not use. Adds escape character ('\') to otherwise-invalid characters, such as backslash, quote and parens, in supplied zero-terminated string.

Syntax

HRESULT MimeOleEscapeString(
  _In_  CODEPAGEID cpiCodePage,
  _In_  LPCSTR     pszIn,
  _Out_ LPSTR      *ppszOut
);

Parameters

cpiCodePage [in]

Type: CODEPAGEID

Specifies a code page. See CODEPAGEID.

pszIn [in]

Type: LPCSTR

Specifies the target string.

ppszOut [out]

Type: LPSTR*

On success, returns a pointer to the escaped string.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
Indicates ppszOut was allocated and set to the escaped string.
S_FALSE
Indicates ppszOut is NULL - pszIn did not require escaping.

Requirements

Minimum supported client
Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Product
Outlook Express 6.0
Header
Mimeole.h
Library
Inetcomm.lib
DLL
Inetcomm.dll (version 6.0 or later)