就业培训     下载中心     Wiki     联络 登录   注册

---

◆  ~BaseLink()

成员函数文档编制

◆  Alloc()

Allocates a base link. Destroy the allocated base link with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

返回

The allocated base link, or nullptr if the allocation failed.

◆  Free()

Destructs base links allocated with Alloc() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

参数

[in,out]

link

The base link to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆  GetLink()

Evaluates the link in the specified document.
若 instanceof is specified, nullptr is returned if the object is not of this type.

参数

[in]	doc	The document to evaluate the link in. The caller owns the pointed document.
[in]	instanceof	Set this to a node type ID to only return the link if it is of this type.

返回

The linked object, or nullptr if the link is broken or of the wrong type. The document owns the pointed object.

◆  GetLinkAtom()

Evaluates the atom link in the specified document.
若 instanceof is specified, nullptr is returned if the atom object is not of this type.

参数

[in]	doc	The document to evaluate the link in. The caller owns the pointed document.
[in]	instanceof	Set this to a type ID to only return the link if it is of this type.

返回

The linked atom object, or nullptr if the link is broken or of the wrong type. The document owns the pointed atom object.

◆  ForceGetLink()

Retrieves the stored link independent of a document.
Can return nullptr if there is no object linked. For example:

• 对象 A is inserted into document B .
  
• SetLink ( A ) is called.
  
• GetLink ( B ) is called : returns A .
  
• 对象 A is removed from document B .
  
• GetLink ( B ) is called : returns nullptr .
  
• ForceGetLink() is called : returns A .
  
• 对象 A is deleted.
  
• ForceGetLink() is called : returns nullptr .

  返回

  The linked object, or nullptr if the link is broken. The document owns the pointed object.

◆  ForceGetLinkAtom()

Retrieves the stored atom link independent of a document.
Can return nullptr if there is no object linked. For example:

• 对象 A is inserted into document B .
  
• SetLink ( A ) is called.
  
• GetLink ( B ) is called : returns A .
  
• 对象 A is removed from document B .
  
• GetLink ( B ) is called : returns nullptr .
  
• ForceGetLink() is called : returns A .
  
• 对象 A is deleted.
  
• ForceGetLink() is called : returns nullptr .

  返回

  The linked atom object, or nullptr if the link is broken. The document owns the pointed atom object.

◆  SetLink()

Sets the link to point to list .

参数

[in]

list

The new atom goal. The caller owns the pointed atom goal.

◆  Read()

Reads the link from a hyper file.

参数

[in]

hf

The hyper file to read from. The caller owns the pointed hyper file.

返回

true if the link was read, otherwise false .

◆  Write()

Writes the link to a hyper file.

参数

[in]

hf

The hyper file to write to. The caller owns the pointed hyper file.

返回

true if the link was written, otherwise false .

◆  GetClone()

Gets a copy of the link.

参数

[in]	flags	Flags for the clone: COPYFLAGS
[in]	trn	An alias translator for the operation. Can be nullptr . The caller owns the pointed alias translator.

返回

The cloned link. The caller owns the pointed link.

◆  CopyTo()

Copies the link to dst .

参数

[in]	dst	The destination link. The caller owns the pointed link.
[in]	flags	Flags for the copy: COPYFLAGS
[in]	trn	An alias translator for the operation. Can be nullptr . The caller owns the pointed alias translator.

返回

true if the link was copied, otherwise false .

◆  IsCacheLink()

Checks if the link points to an object within the cache of another object.

返回

true if this link points to an object's cache, otherwise false .

◆  SetUpPointer()

Private .

• BaseLink