ACAPI_ElementGroup_SetUserData
사용자 데이터를 요소 그룹에 부착합니다.
GSErrCode ACAPI_ElementGroup_SetUserData ( const API_Guid& groupGuid const API_UserData* userData );
파라미터
- groupGuid
- [in] 요소 그룹의 유일 ID입니다.
- userData
- [in] 새로운 사용자 데이터에 대한 포인터입니다.
리턴 값
NoError
- 함수가 성공적으로 완료되었습니다. 새로운 사용자 데이터가 요소 그룹에 부착됩니다.
APIERR_REFUSEDCMD
- 함수는 반드시 undoable이어야 합니다. 열린 undoable session이 없습니다.
APIERR_BADID
- 전달된 groupGuid ID가 유효하지 않습니다.
APIERR_BADPARS
- 전달된 groupGuid 파라미터가
NULL
입니다. APIERR_BADPLATFORMSIGN
- 주어진 플랫폼 기호가 유효하지 않습니다. (범위 밖입니다)
APIERR_MEMFULL
- 메모리가 부족합니다.
다른 공통 API 오류들에 대해서는 API 오류 문서를 보십시오.
설명
이 함수는 사용자 데이터를 요소 그룹에 부착하는 데 사용합니다.
요소 그룹으로부터 데이터를 가져오려면 ACAPI_ElementGroup_GetUserData 함수를 사용하십시오.
userData 입력 파라미터를 NULL
로 설정하면 기존의 사용자 데이터를 제거할 수 있습니다.
이 함수는 undoable하지 않다는 것을 참고하십시오.
호출자는 userData->dataHdl
핸들을 할당 및 해제를 해야 합니다.
요구사항
- 버전: API 18 또는 이후
- 헤더: ACAPinc.h
참고사항
API_UserData
ACAPI_ElementGroup_GetUserData
ACAPI_ElementGroup_Create
ACAPI_ElementGroup_GetGroup
ACAPI_ElementGroup_GetRootGroup
ACAPI_ElementGroup_GetGroupedElems
ACAPI_ElementGroup_GetAllGroupedElems
API 함수