Home page  
Help >
DdTxtDecodeParams() - decode MEMO pointer parameters
Version 7.11
DdTxtDecodeParams() - decode MEMO pointer parameters DdTxtDecodeParams() - decode MEMO pointer parameters
   void DdTxtDecodeParams(
      WtChar8 pointer[FSZMemo],   /* [IN] pointer string */
      WtLong64 *sbnRef,           /* [OUT] - return starting block number */
      WtInt32 *nbRef,             /* [OUT] - pointer to number of blocks; or NULL */
      WtInt16 *subBlockOffsetRef, /* [OUT] - pointer to sub-block offset; or NULL */
      WtInt16 *subBlockSizeRef)   /* [OUT] - pointer to sub-block size; or NULL */
 
Description of Parameter pointer[FSZMemo]
   pointer[FSZMemo] is a character array that contains encoded information describing
   an existing MEMO/BLOB field. If no MEMO/BLOB field exists, pointer[FSZMemo]
   contains all blanks.
 
   FSZMemo is equal to the global symbol TBAPI_INTERNAL_MEMO_MARKER_LENGTH
   which is defined in ddl_defs.h.
 
Description og Parameter sbnRef
   sbnRef is a pointer to a user variable where the decoded value of sbn is 
   returned.
 
   If the pointer string is all blanks, or if the pointer string does not contain
   a valid pointer, the return value for sbn is 0.
 
Description og Parameter nbRef
   nbRef is a pointer to a user variable where the decoded value of nb is 
   returned.
 
   nb is the number of 512 byte blocks allocated to the MEMO/BLOB field.
   Thus, is can be used as an estimator of the MEMO/BLOB field's size.
   However, when subBlockSize is non-zero [see below], nb is 0;
 
Description og Parameter subBlockOffsetRef
   subBlockOffsetRef is a pointer to a user variable where the decoded value of
   subBlockOffset is returned.
 
   subBlockOffset is an essential TB API parameter; but it has no significance
   to a client application.
 
Description og Parameter subBlockSizeRef
   subBlockSizeRef is a pointer to a user variable where the decoded value of
   subBlockSize is returned.
 
   When nb is 0 [see above], subBlockSize is an estimator of the MEMO/BLOB field's size.
 

Copyright © 2019 , WhamTech, Inc.  All rights reserved. This document is provided for information purposes only and the contents hereof are subject to change without notice. Names may be trademarks of their respective owners.