IixssoUtil::TruncateToWhitespace method

[Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.]

Truncates a string at a white-space character. Script writers can call this method to display short forms of the value of long properties like the contents of the Description property without truncating in the middle of a word.

Syntax


HRESULT TruncateToWhitespace(
  [in]          BSTR pwszString,
  [in]          LONG cchLen,
  [out, retval] BSTR *ppwszOutput
);

Parameters

pwszString [in]

The string to be truncated.

cchLen [in]

The maximum length of the string.

ppwszOutput [out, retval]

The truncated string.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The space checking of this method doesn't work well with NLS; however it works well in ANSI. There is no equivalent routine for Asian languages.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

End of client support

Windows 7

End of server support

Windows Server 2008 R2

DLL

Ixsso.dll

See also

IixssoUtil

 

 

Show: