ITextStrings::GetCch method

Gets the count of characters for a selected string index.

Syntax


HRESULT GetCch(
  [in]   long iString,
  [out]  long *pcch
);

Parameters

iString [in]

Type: long

The string index.

pcch [out]

Type: long*

The string character count.

Return value

Type: HRESULT

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

The index is relative to the top of the collection, so iString = 0 returns the character count of the top string, iString = –1 returns that for the one below the top string, and so on.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

ITextStrings

 

 

Community Additions

ADD
Show:
© 2014 Microsoft