GetPartHandle

From SIMboxWiki
Revision as of 23:45, 7 June 2013 by Leslie Brown (talk | contribs) (Created page with '=== Description === Use the function '''GetPartHandle '''to access the handle of a subpart in a specified object. The handle is later used to refer to the subpart faster than b…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

Use the function GetPartHandle to access the handle of a subpart in a specified object. The handle is later used to refer to the subpart faster than by its name.

Syntax

ZS_DECL LPARAM ZSAPI GetPartHandle(

UINT nID,
LPCSTR szName
);

Parameters

UINT nID

[in] Handle to object.

LPCSTR szName

[in] Specifies the subpart name. NULL specifies the objects in nID.

Return Value

Handle to part.

Remarks

Parts can be referred by their name or handle. Referring to a part with its name performs a lookup operation, while referring with the handle gives direct access to the part. To get the handle for an object, enter NULL in zsName.

See also: zsMovePart, zsMovePartByID