IPXS_Inst::HasAtom Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_Inst::HasAtom Method}}
 
{{#customTitle:IPXS_Inst::HasAtom Method}}
 +
{{#parentPage:PXV:IPXS_Inst#Methods|HasAtom|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Tests whether an atom exists for the specified string.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT HasAtom([in] LPWSTR pString, [out, retval] VARIANT_BOOL* pHasAtom);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT HasAtom([in]           LPWSTR         sString,
 +
                [out, retval] VARIANT_BOOL* bHasAtom);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pString''
+
;sString
:[in] Value of LPWSTR.
+
:[in] Null terminated Unicode string to test.
;''pHasAtom''
+
;bHasAtom
:[out, retval] Pointer to VARIANT_BOOL.
+
:[out, retval] Pointer to VARIANT_BOOL variable that receives the test result.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 22:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXS_Inst|IPXS_Inst]].
+
[[PXV:IPXS_Inst|IPXS_Inst]], [[PXV:IPXS_Inst_StrToAtom|StrToAtom]], [[PXV:IPXS_Inst_AtomToStr|AtomToStr]]

Latest revision as of 05:17, 15 June 2015


Tests whether an atom exists for the specified string.

Syntax

HRESULT HasAtom([in]           LPWSTR         sString,
                [out, retval]  VARIANT_BOOL*  bHasAtom);

Parameters

sString
[in] Null terminated Unicode string to test.
bHasAtom
[out, retval] Pointer to VARIANT_BOOL variable that receives the test result.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXS_Inst, StrToAtom, AtomToStr